diff --git a/INSTALL.md b/INSTALL.md index 780701c5779a0104f5336281e6cd3b62f1d3fe38..0f861a8994cb5bc11e9ead18ce691593dd297361 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -14,19 +14,26 @@ cd carputils This section explains how to build carputils and install it using `pip`. This is recommended if you do not expect to develop carputils. -In the carputils directory, to install carputils in the Python user-space, run +In order to avoid conflicts in Python dependencies, we recommend to install carputils within a virtual environment. +A virtual environment can be created in the current directory with the following command: ``` -python3 -m pip install . --user +python3 -m venv carputils_env ``` -If the Python user-space bin folder is not in your `PATH`, you should add this line to your `.bashrc`. +This environment should then be activated each time you want to use carputils with: ``` -export PATH="$PATH:`python3 -m site --user-base`/bin" +. ./carputils_env/bin/activate ``` +Once the environment is activated, install carputils with pip: +``` +python -m pip install /path/to/carputils +``` +where `/path/to/carputils` should be replaced with the path to the carputils folder. + You can then generate the carputils settings file `settings.yaml` if it does not exist: ``` -python3 ./bin/cusettings $HOME/.config/carputils/settings.yaml +cusettings $HOME/.config/carputils/settings.yaml ``` This file contains the carputils settings, including the paths to openCARP binary files. It contains default values adapted to your local setup, but can be modified manually.