For adding new measures, we recommend usingAnaconda to manage your environment so that even if you mess something up, you can always have a safe and clean restart. A guide for managing python environments with Anaconda can be foundhere.

After installing Anaconda, create a new environment with:

$ conda create -n commonroad-py38 python=3.8 -y

Here the name of the environment is calledcommonroad-py38. You may also change this name as you wish. In such case, don't forget to change it in the following commands as well.Always activate this environment before you do anything related:

$ conda activate commonroad-py38or$source activate commonroad-py38

Then, install the dependencies with:

$cd<path-to-this-repo>$ pip install -e.$ conda develop.

To test the installition, run unittest:

$cd tests$ python -m unittest -v

1. create a new branch withfeature-<measure-name> and checkout the branch
2. navigate tocommonroad_crime/data_structure/type.py to find the correct category of the measure and add anenumeration entry<abbreviation>: <explanation>
3. navigate tocommonroad_crime/measure to find the above-mentioned category and create a python file named<abbreviation>.py. Then create a class inheriting theCriMeBase undercommonroad_crime/data_structure/base.py
4. similar to other measures, you need to implement thecompute() andvisualize() functions

1. navigate tocommonroad_crime/data_structure/configuation.py to find the above-mentioned category and add a newinstance to the class asself.<parameter> = config_relevant.<parameter>
2. you can then directly call the values usingself.configuration.<category>.<parameter> in your measure class
3. to override the default parameter values, create ayaml file (name it the same as the scenario) in./config_files and modify the values there

$ pip install -r ./docs/requirements_doc.txt$cd docs/sphinx$ make html

The documentation can then be launched by browsing./docs/sphinx/build/html/index.html/.