modelverse/doc/interaction.rst

Basic Interaction
=================

As previously mentioned during the installation phase, the Modelverse is merely a collection of scripts.
We briefly present how the Modelverse is structured, and introduce the most important scripts for general use.
A more elaborate view on the architecture and the different scripts is only required for developers of the Modelverse.

Simplified Architecture
-----------------------

The Modelverse architecture consists of three core concepts, which will be referred to throughout the documentation.

Modelverse State (MvS)
^^^^^^^^^^^^^^^^^^^^^^

The Modelverse State (MvS) is the memory of the Modelverse, and contains all data pertaining to it.
This includes not only the different models created by the users, but also all metamodels, transformations, operations, but also all bootstrap files.
Furthermore, it includes all execution state of operations being executed in the Modelverse.
As such, the Modelverse State is the database of the Modelverse, which is the only component containing data.
Only developers will ever have to directly interface with the Modelverse State.

Modelverse Kernel (MvK)
^^^^^^^^^^^^^^^^^^^^^^^

The Modelverse Kernel (MvK) is the execution core of the Modelverse, and connects to the Modelverse State to fetch the instructions to execute.
All its execution information is stored in the MvS as well, and therefore it has to (theoretically) query the MvS for each and every instruction.
It merely consists of a set of model transformation rules which take the current state of the MvS, and do a set of modifications on it.
Only developers will ever have to directly interface with the Modelverse Kernel.

Modelverse Interface (MvI)
^^^^^^^^^^^^^^^^^^^^^^^^^^

The Modelverse Interface (MvI) ...

Necessary scripts
-----------------

Explain the different scripts and how they can be used
Briefly show the *run_tests.py* and *run_local_modelverse.py*
Also *prompt.py*

Wrapper
-------

We explain the simple Python wrapper
Other wrappers can be defined quite easily due to the Modelverse architecture
Later is a full overview of the wrapper, we now introduce it piece by piece in Python