Skip to content

Commit

Permalink
added some explanatory comments to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kosovan committed Sep 13, 2024
1 parent c2c4b21 commit f2d3b21
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,11 +63,12 @@ sudo apt install python3-venv
To set up pyMBE, the users need to install its virtual environment, install its Python dependencies and configure the path to the ESPResSo build folder as follows:

```sh
python3 -m venv pymbe
source pymbe/bin/activate
python3 maintainer/configure_venv.py --espresso_path=/home/user/espresso/build # adapt path
python3 -m venv pymbe # creates a local folder named pymbe, which contains the virtual environment
source pymbe/bin/activate # activates the pymbe venv
python3 maintainer/configure_venv.py --espresso_path=/home/user/espresso/build # please, adapt the espresso path accordingly
python3 -m pip install -r requirements.txt
deactivate
python3 simulation_script.py # run the espresso simulation script
deactivate # deactivate the virtual environment
```

We highlight that the path `/home/user/espresso/build` is just an example of a possible
Expand Down

0 comments on commit f2d3b21

Please sign in to comment.