diff --git a/content/docs/adapters/fenics/adapter-fenics.md b/content/docs/adapters/fenics/adapter-fenics.md index d3779ea85bc..96dedfdca68 100644 --- a/content/docs/adapters/fenics/adapter-fenics.md +++ b/content/docs/adapters/fenics/adapter-fenics.md @@ -30,7 +30,7 @@ The adapter requires FEniCS and preCICE version 2.0 or greater and the preCICE l ### Use `pip` -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. +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. ### Use `conda` (or `mamba`) diff --git a/content/docs/adapters/nutils/adapter-nutils.md b/content/docs/adapters/nutils/adapter-nutils.md index ab58ae1d5f1..39a740c948d 100644 --- a/content/docs/adapters/nutils/adapter-nutils.md +++ b/content/docs/adapters/nutils/adapter-nutils.md @@ -17,4 +17,4 @@ The best way to learn how to couple a [Nutils](http://www.nutils.org/) applicati 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. -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`. +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)). diff --git a/content/docs/dev-docs/dev-tooling.md b/content/docs/dev-docs/dev-tooling.md index e38ad57df4b..88f9db3cab7 100644 --- a/content/docs/dev-docs/dev-tooling.md +++ b/content/docs/dev-docs/dev-tooling.md @@ -47,7 +47,7 @@ To manually format configuration files, use pre-commit. pre-commit run -va format-precice-config ``` -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: +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: ```bash format_precice_config.py precice-config.xml diff --git a/content/docs/installation/bindings/installation-bindings-python.md b/content/docs/installation/bindings/installation-bindings-python.md index d4b6be70f99..4a4e918e9bf 100644 --- a/content/docs/installation/bindings/installation-bindings-python.md +++ b/content/docs/installation/bindings/installation-bindings-python.md @@ -2,7 +2,7 @@ title: Python bindings permalink: installation-bindings-python.html keywords: configuration, basics, overview, installation, bindings -summary: "Use pip3 install --user pyprecice to install the python language bindings from PyPI" +summary: "Use pip3 install pyprecice to install the python language bindings from PyPI" --- ## The versioning scheme @@ -13,7 +13,7 @@ Example: version `1` of the python bindings for preCICE version `2.2.0` is `2.2. ## Installation -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. +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. ### Alternatives & Community packages