Skip to content

Commit

Permalink
Merge pull request #70 from scientificcomputing/finsberg/readme-conda
Browse files Browse the repository at this point in the history
Update installation instructions in README - add conda
  • Loading branch information
finsberg authored Nov 20, 2024
2 parents ffbe361 + 1690f1e commit 2de9542
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,35 @@ The package is still in its early stages and many functionalities are still miss

## Installation

The package is partly written in C++ and relies on `dolfinx`. User are encouraged to install `scifem` in an environment where `dolfinx` is already installed.
The package can be installed using `pip`:
The package is partly written in C++ and relies on `dolfinx`. User are encouraged to install `scifem` with `pip` in an environment where `dolfinx` is already installed or with `conda`.

### `pip`
To install the package with `pip` run

```bash
python3 -m pip install scifem --no-build-isolation
```

or from `git` with
To install the development version you can run

```bash
python3 -m pip install --no-build-isolation git+https://github.com/scientificcomputing/scifem.git
```

Note that you should pass the flag `--no-build-isolation` to `pip` to avoid issues with the build environment, such as incompatible versions of `nanobind`.

### `conda`

To install the package with `conda` run

```bash
conda install -c conda-forge scifem
```





## Having issues or want to contribute?

If you are having issues, feature request or would like to contribute, please let us know. You can do so by opening an issue on the [issue tracker](https://github.com/scientificcomputing/scifem/issues).

0 comments on commit 2de9542

Please sign in to comment.