Skip to content

Commit 3651218

Browse files
authored
Replace pip install --user suggestion with a venv (#677)
closes #398
1 parent b4a7e92 commit 3651218

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

content/docs/adapters/fenics/adapter-fenics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The adapter requires FEniCS and preCICE version 2.0 or greater and the preCICE l
3030

3131
### Use `pip`
3232

33-
The adapter is [published on PyPI](https://pypi.org/project/fenicsprecice/). After installing preCICE and the python language bindings, run `pip3 install --user fenicsprecice` to install the adapter via your Python package manager.
33+
The adapter is [published on PyPI](https://pypi.org/project/fenicsprecice/). After installing preCICE and the python language bindings, run `pip3 install fenicsprecice` in a [virtual environment](https://docs.python.org/3/library/venv.html#creating-virtual-environments) to install the adapter via your Python package manager.
3434

3535
### Use `conda` (or `mamba`)
3636

content/docs/adapters/nutils/adapter-nutils.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ The best way to learn how to couple a [Nutils](http://www.nutils.org/) applicati
1717

1818
We recommend using a Python virtual environment to install different Nutils versions. See the `requirements.txt` and the `run.sh` of the cases included in the preCICE tutorials for an example.
1919

20-
Version 8 requires `bottombar` as a dependency. `pip` might automatically install version `2.0`, which has [known issues](https://github.com/precice/precice/issues/1443) when used with preCICE. A [patch](https://github.com/evalf/bottombar/commit/fd2dc3a76db282e5ba1f12047683100a299cf651) was implemented in version `2.1`, thus a workaround is to explicitly re-install version `2.1`: `pip3 install --user bottombar==2.1`.
20+
Version 8 requires `bottombar` as a dependency. `pip` might automatically install version `2.0`, which has [known issues](https://github.com/precice/precice/issues/1443) when used with preCICE. A [patch](https://github.com/evalf/bottombar/commit/fd2dc3a76db282e5ba1f12047683100a299cf651) was implemented in version `2.1`, thus a workaround is to explicitly re-install version `2.1`: `pip3 install bottombar==2.1` (in the same [virtual environment](https://docs.python.org/3/library/venv.html#creating-virtual-environments)).

content/docs/dev-docs/dev-tooling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ To manually format configuration files, use pre-commit.
4747
pre-commit run -va format-precice-config
4848
```
4949

50-
To format your `precice-config.xml`, you can use the script `format_precice_config.py` which is part of the [preCICE pre-commit hooks](https://github.com/precice/precice-pre-commit-hooks) (without needing to install the pre-commit hooks) and depends on the lxml package (install it with `pip install --user lxml`). To format a file in place:
50+
To format your `precice-config.xml`, you can use the script `format_precice_config.py` which is part of the [preCICE pre-commit hooks](https://github.com/precice/precice-pre-commit-hooks) (without needing to install the pre-commit hooks) and depends on the lxml package (install it with `pip install lxml` in a [virtual environment](https://docs.python.org/3/library/venv.html#creating-virtual-environments)). To format a file in place:
5151

5252
```bash
5353
format_precice_config.py precice-config.xml

content/docs/installation/bindings/installation-bindings-python.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Python bindings
33
permalink: installation-bindings-python.html
44
keywords: configuration, basics, overview, installation, bindings
5-
summary: "Use pip3 install --user pyprecice to install the python language bindings from PyPI"
5+
summary: "Use pip3 install pyprecice to install the python language bindings from PyPI"
66
---
77

88
## The versioning scheme
@@ -13,7 +13,7 @@ Example: version `1` of the python bindings for preCICE version `2.2.0` is `2.2.
1313

1414
## Installation
1515

16-
The python bindings for preCICE are [published on PyPI](https://pypi.org/project/pyprecice/) with the package `pyprecice`. You can use your python package manager for installing the language bindings. For example, `pip3 install --user pyprecice`. This will automatically install the latest version of the bindings compatible with the latest version of preCICE. If you are using an older version of preCICE, you have to explicitly tell pip to download the correct version (For example, `pip3 install --user pyprecice==2.2.0.2` for preCICE version `2.2.0`). See [the PyPI release history](https://pypi.org/project/pyprecice/#history) for a list of available version. Note that preCICE and MPI have to be installed on your system.
16+
The python bindings for preCICE are [published on PyPI](https://pypi.org/project/pyprecice/) with the package `pyprecice`. You can use your python package manager for installing the language bindings. For example, run `pip3 install pyprecice` in a [virtual environment](https://docs.python.org/3/library/venv.html#creating-virtual-environments). This will automatically install the latest version of the bindings compatible with the latest version of preCICE. If you are using an older version of preCICE, you have to explicitly tell pip to download the correct version (For example, `pip3 install pyprecice==2.2.0.2` for preCICE version `2.2.0`). See [the PyPI release history](https://pypi.org/project/pyprecice/#history) for a list of available version. Note that preCICE and MPI have to be installed on your system.
1717

1818
### Alternatives & Community packages
1919

0 commit comments

Comments
 (0)