No Description

Yentl Van Tendeloo 89404372d2 Add requirements.txt for easy installation of dependencies, and a tox file 3 years ago
bootstrap 89404372d2 Add requirements.txt for easy installation of dependencies, and a tox file 3 years ago
doc 6122600f36 More notes in the problems section of the documentation 3 years ago
examples 15813c7019 Faster HUTN compiler through the use of buffers 3 years ago
hybrid_server b986e94de0 Add more (passing) tests for transformation_execute_MANUAL 3 years ago
integration 6f19274ab2 Permission updates 3 years ago
interface a653799899 Fixes to broken references in compilation errors 3 years ago
kernel c3ed0ecf7d Add auto-generated MvK rules 3 years ago
model 1c317d0b84 Revert "Merge branch 'DEVS' into testing" 3 years ago
models 7aa25ebfec Fixed compilation error in to_SCCD model 3 years ago
scripts 7aa25ebfec Fixed compilation error in to_SCCD model 3 years ago
services b93bdf64d6 Remove prints 3 years ago
state e480917c8f Implemented Modelverse Garbage Collection again (quite efficiently) 3 years ago
unit 60d9020358 Fixed another test 3 years ago
wrappers 56c7bb8ff4 Fix another error in tests 3 years ago
.gitattributes b3d374390d Make .gz files merge properly 4 years ago
.gitignore 0db83d0de7 Ignore temporary DEVS models 3 years ago
README.md 592282cbcf Massive cleanup 4 years ago
notebook.ipynb 330fe37bf3 Fix bootstrap file not being properly uploaded 3 years ago
requirements.txt 89404372d2 Add requirements.txt for easy installation of dependencies, and a tox file 3 years ago
tox.ini 89404372d2 Add requirements.txt for easy installation of dependencies, and a tox file 3 years ago

README.md

Installation

Installing the Modelverse is unnecessary, as it is mere Python code and doesn't use installation scripts. All scripts which are generally useful are found in the 'scripts' directory, and are written in OS-independent Python code.

You will, however, need to install a dependency: the SCCD compiler and runtime.

Starting up the Modelverse

Starting up the Modelverse is easy: simply execute the scripts/run_local_modelverse.py script, with as parameter the port you want to use. By default, port 8001 is used.

Communicating with the Modelverse

Now that the Modelverse is running, you will want to communicate with it! To do this, you can use whatever tool you want, as long as it can send and receive XML/HTTPRequests. For example, a mere internet browser can already communicate with the Modelverse, though not in the most user-friendly way.

A nicer way is through the Python prompt script scripts/prompt.py. After that, it will print out all the output of the Modelverse, and send in all your queries directly to the Modelverse.

Python wrapper

To automatically communicate with the Modelverse in a programmatic way, a Python wrapper is provided. This wrapper is found in wrappers/modelverse.py, and provides Python functions that make the necessary Modelverse requests. At the moment, not all functions are implemented in the wrapper yet.

Performance

Performance of the Modelverse is currently rather low. This is primarily caused by the reliance on the action language, which is an explicitly modelled (and interpreted) language. Additionally, the Modelverse runs remotely, meaning that all requests have to pass over the network. Even when this is executed on the same machine, this causes quite some overhead.

Additional documentation

Some additional documentation can be found online in the Modelverse techreport, describing the internal workings of the Modelverse, as well as a brief introduction on how to use it. There is also in-depth documentation describing how to use the Modelverse and its various languages.

Tests

Running the tests is easy: simply execute scripts/run_tests.py in the main modelverse folder. This will invoke the necessary build commands (to create bootstrapping code etc.) and call the tests for each individual aspect of the Modelverse. Note that testing is done using py.test, which is the only dependency of the Modelverse (and only for tests, of course).

Using PyPy

Since all scripts chain the invocation with the same interpreter as originally invoking the script, you will need to install py.test for PyPy. Assuming that you already have PyPy installed, you can simply install py.test using these commands:

wget https://msdl.uantwerpen.be/files/get-pip.py
pypy get-pip.py --user
pypy -m pip install pytest --user

From then on, you can simply invoke all tests in PyPy using:

pypy scripts/run_tests.py