FACT is a domain specific language to model continuous-time systems. For motivation and in-depth presentation of the main ideas, please refer to
- Edil Medeiros, Eduardo Peixoto, Eduardo Lemos, FACT: A Domain-Specific Language Based on a Functional Algebra for Continuous Time Modeling, 2023 Winter Simulation Conference.
It mandatory to have cabal installed. From the root of the project, the following command starts the REPL environment:
cabal repl
Moreover, the project can be compiled and executed using the following command (the main function is redirecting to running Lorenz Attractor benchmarks):
cabal run
All the examples in the Examples folder are acessible via the REPL environment.
There are two types of documentation: thesis.lhs and manual.lhs, both of which use literate programming, given that Haskell has great support to this feature. The former is the graduation thesis of one contributor, and latter is the manual of the software.
The most convenient way to compile the documentation and the executable from these files is by using the script literate.sh, inside the doc folder. Below, there are the available commands to execute in the terminal:
/literate.sh manual compile- It is necessary to have installed theghccompiler (must be in your PATH variable). It will compile the filemanual.lhs./literate.sh manual repl- It is necessary to have installed theghciinteractive enironment (must be in your PATH variable). It will start a REPL of the filemanual.lhs./literate.sh manual gray- It is necessary to have installed lhs2Tex and pdflatex (both must be in your PATH variable). It will generate a black and white document frommanual.lhs, following lhs2Tex guidelines./literate.sh manual colorful- It is necessary to have installed pygments (must be in your PATH variable). It will generate a colorful version of the document frommanual.lhsusing the minted package./literate.sh thesis compile- It is necessary to have installed theghccompiler (must be in your PATH variable). It will compile the filethesis.lhs./literate.sh thesis repl- It is necessary to have installed theghciinteractive enironment (must be in your PATH variable). It will start a REPL of the filethesis.lhs./literate.sh thesis gray- It is necessary to have installed lhs2Tex and pdflatex (both must be in your PATH variable). It will generate a black and white document fromthesis.lhs, following lhs2Tex guidelines./literate.sh thesis colorful- It is necessary to have installed pygments (must be in your PATH variable). It will generate a colorful version of the document fromthesis.lhsusing the minted package.
All commands need to be executed inside the doc folder. All of these commands use the same file, manual.lhs or thesis.lhs, to execute different things. In this way, documentation and source code come from the same file.
As a shortcut, the colorful version of the thesis can be compiled using the following sequence of commands in a linux machine (Ubuntu) from the root folder:
sudo apt-get install texlive-latex-base
sudo apt-get install texlive-fonts-extra
cd doc
./literate.sh thesis colorful
FACT (Functional Algebra for Continuous Time) is a reduced and updated version of aivika. This project has the main goal of incresing the understanding of aivika incrementally, using the earlier versions of the code (the earliest version is only available in hackage). Hence, it is necessary to update the code, since the ghc compiler changed a lot since back these versions where developed.