Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify installation procedure #183

Merged
merged 4 commits into from
Oct 31, 2024
Merged

Clarify installation procedure #183

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
113fb93
Add note regarding the externally-managed-environment error
NiklasVin Sep 15, 2024
cc46f38
Missing blank line
NiklasVin Sep 15, 2024
7416af9
Tweak location and provide commands that we use in tutorials.
BenjaminRodenberg Oct 31, 2024
c99b41d
Add language.
BenjaminRodenberg Oct 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,18 @@
It is recommended to install [fenicsprecice from PyPI](https://pypi.org/project/fenicsprecice/) via

```bash
pip3 install --user fenicsprecice
pip3 install fenicsprecice
```

For more recent pip versions you may encounter the error `error: externally-managed-environment` during installation of the fenicsprecice. You can read why [here](https://packaging.python.org/en/latest/specifications/externally-managed-environments/). In this case, it is recommended to create a virtual environment and install the package in the virtual environment. The following commands will create the virtual environment `venv_name` at the location `path/of/your/venv/`:

```

Check failure on line 35 in README.md

View workflow job for this annotation

GitHub Actions / Lint scripts and docs 

Fenced code blocks should have a language specified [Context: "```"]
python3 -m venv --system-site-packages path/of/your/venv/venv_name
. path/of/your/venv/venv_name/bin/activate
```

You can replace `path/of/your/venv/venv_name` with the location and name you want to use for your virtual environment. The command `--system-size-packages` will allow the virtual environment to access the FEniCS installation on your system. Refer to the [Python documentation](https://docs.python.org/3/library/venv.html) for further details on virtual environments.

This should work out of the box, if all dependencies are installed correctly. If you face problems during installation or you want to run the tests, see below for a list of dependencies and alternative installation procedures

### Clone this repository and use pip3
Expand Down
Loading