Movici Viewer

The Movici Viewer is a tool to visualize simulations which are performed using Movici and stored on a local disk

Install using pip

pip install movici-viewer

Usage

The Movici Viewer can be started using the following command and pointing it to a valid simulations directory. The required content of the directory is explained below

movici-viewer /path/to/your/simulations

Simulations Directory

A Simulations directory should contain the following:

• An init_data directory with all initial datasets. Datasets files must follow the pattern: <dataset_name>.<ext>. Only .json files are fully supported.
• A scenarios directory that contains, per Scenario:
  • <scenario_name>.json: Scenario config.
  • (Optional) <scenario_name>/ a directory with all updates for this Scenario (if available). The updates in this directory must follow the naming pattern t<timestamp>_<iteration>_<dataset_name>.json which is the default naming pattern of movici-simulation-core simulations. If this directory does not exist, the Scenario is consired to be not-run.
• (Optional) A /views/ directory with /views/<scenario_name>/ subdirectories per scenario, containing View-files names <view_name>.json. These directories will be created by default upon saving Views in the Movici Viewer.

An example directory tree is as following:

├── init_data
│   └── my_dataset.json
├── scenarios
│   ├── my_scenario
│   │   ├── t0_0_my_dataset.json
│   │   └── t0_1_my_dataset.json
│   ├── my_scenario.json
│   └── other_scenario.json
└── views
    └── my_scenario
        └── my_view.json

Development

Development requires poetry, a tool for managing and building python packages. Install it using pip or pipx.

Upon first checkout of this repository, run make init. This will

• install node modules for the client
• build/bundle the client
• populate the server with the client bundle
• install the server package

Server development

The development requirements should already be installed after running make init. A development server can be started using

make run-devel

This will run the development server with the tests/data as its simulations directory. To specify a custom directory run

make run-devel data_dir=/path/to/my/simulations

Client development

for client development, run the local api server and a Vue development server seperately, eg.:

make run-devel

and in a separate terminal

npm run --prefix client serve