Installation & configuration¶

Installation¶

By running

pip install dymoval

everything should work fine, but there are few things to keep in mind.

Typically conda handles scientific packages better than pip, and given that many dymoval dependencies are scientific packages, it is suggested to install all the dependencies through conda and then to install dymoval through pip.

To do that, download the environment.yml file from here and run

conda env update --name env_name --file environment.yml
pip install dymoval

where env_name is the environment name where you want to install dymoval. If not provided, dymoval will be installed in a new environment called dymoval.

Why not conda install dymoval?¶

Unfortunately, it is not possible (yet?) to easily build conda packages when the project is handled through a pyproject.toml file, and therefore the dymoval package, which uses a pyproject.toml file, is only available through pip.

Installation from the repo¶

Clone the repo from the_repo and run

cd /path/to/where/you/cloned/this/repo
conda env update --name env_name --file environment.yml
conda activate env_name
pip install .

cd /path/to/where/you/cloned/this/repo
pip install .

Configuration¶

The configuration of dymoval is fairly straightforward since there are only two parameters that you can set.

num_decimals¶: Type: int

Default: 4

Number of decimal digits. At the end of every function/method, dymoval round float numbers to a certain number of decimals.

color_map¶: Type: str

Default: “tab10”

The used matplotlib color map. Check Matplotlib docs for possible values.

These parameters can be set through a ~/.dymoval/config.toml file. You have to create such a file manually.

A ~/.dymoval/config.toml could for example include the following content

num_decimals = 4
color_map = "tab20"