Getting started#

Overview#

This section provides information on how to install DYNO and integrate it in your own application.

The recommended installation method is using the Docker image. There are Docker image suitable for developers or end users. If you are unable to use the Docker image, you can run MOMA using a virtual environment.

Quick start#

If you are unsure about your specific application and just want to try and quickly run MOMA on your machine, you can run the following Docker command to get the latest runtime:

docker run -it ghcr.io/au-agv/moma:runtime

If the environment does not activate automatically, you can activate it manually by navigating to the pyproject.toml file and run:

source $(poetry env info --path)/bin/activate

Once inside the container, generate a simple map using default options with the following command:

moma generate_test_map --create_rasters

Mobility maps can then be created by:

moma mobility

Step guide#

For a better understanding in the functions of MOMA follow this guide:

Test MOMA installation

test the MOMA installation by navigating to the main moma directory and run the pytest
```
pytest
```
The test should create a test directory called test/output where a run of the moma map generation is done to test that all the functions runs correct. Output maps are placed in test/output/sites/testmap/export. These does not not necessarily contain valid data due to the limited test map site used to run the test quickly.
Generate the test map

A test map can be generated by using the subcommand generate_test_map and the argument --create_rasters is used to generate the rasters that the mobility map generator uses
```
moma generate_test_map --create_rasters
```
Run moma

The mobility map generator can be run with the subcommand mobility. To clear the terminal before the run the argument --clear is used.
```
moma --clear mobility
```
The generated plots can be show directly by using the argument --show_plots. Be aware that not all docker installations supports the popup windows created by mathplotlib.
Used more parameters

The test map and mobility map generation can be modified with the different arguments. A full list of arguments can be found at User guide, and example calls are availible at Examples

The outputs generated with the following parameters and the default testmap can be seen in the example folder.
```
moma mobility --vehicle mock --site testmap --n_samples 50 --sample_reduction mean --directions N NE E SE S SW W NW omni --path_coordinate_system utm --path_start 10 200 --path_end 240 50 --target_speed 20
```
To work on a different dataset, see the documentation on how to add a new site, data laoder, and vehicle