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

Add installation notes for conda #116

Merged
merged 1 commit into from
Apr 30, 2024
Merged

Add installation notes for conda #116

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 12 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

![MIT](https://img.shields.io/github/license/jorgensd/adios4dolfinx)
[![status](https://joss.theoj.org/papers/7866cb142db8a803e32d79a109573d25/status.svg)](https://joss.theoj.org/papers/7866cb142db8a803e32d79a109573d25)
[![Anaconda-Server Badge](https://anaconda.org/conda-forge/adios4dolfinx/badges/version.svg)](https://anaconda.org/conda-forge/adios4dolfinx)

ADIOS4DOLFINx is an extension for [DOLFINx](https://github.com/FEniCS/dolfinx/) to checkpoint meshes, meshtags and functions using [ADIOS 2](https://adios2.readthedocs.io/en/latest/).

Expand All @@ -21,12 +22,13 @@ The `adios4dolfinx` library extends the [DOLFINx](https://github.com/FEniCS/dolf

Compatibility with DOLFINx:

- ADIOS4DOLFINx v0.7.3 is compatible with DOLFINx v0.7.x
- ADIOS4DOLFINx v0.8.1 is compatible with DOLFINx v0.8.x
- ADIOS4DOLFINx v0.7.3 is compatible with DOLFINx v0.7.x

### Dependencies

The library depends on the Python-interface of [DOLFINx](https://github.com/) and an MPI-build of [ADIOS2](https://adios2.readthedocs.io/en/latest/setting_up/setting_up.html#as-package) and can therefore not be installed through PyPi, but has to be installed through Conda, Spack or from source.
The library depends on the Python-interface of [DOLFINx](https://github.com/) and an MPI-build of [ADIOS2](https://adios2.readthedocs.io/en/latest/setting_up/setting_up.html#as-package).
Therefore `ADIOS2` should not be install through PYPI/pip, but has to be installed through Conda, Spack or from source.

### Docker

Expand Down Expand Up @@ -70,16 +72,17 @@ Following is a minimal recipe of how to install adios4dolfinx, given that you ha
```bash
conda create -n dolfinx-checkpoint python=3.10
conda activate dolfinx-checkpoint
conda install -c conda-forge fenics-dolfinx pip adios2=*=mpi_*
python3 -m pip install adios4dolfinx[test]@git+https://github.com/jorgensd/[email protected]
conda install -c conda-forge adios4dolfinx
```

> [!NOTE]
> To run the tests or demos associated with the code, install `ipyparallel` in your environment, for instance by calling
>
> ```bash
> python3 -m pip install adios4dolfinx[test]@git+https://github.com/jorgensd/[email protected]
> ```
> Remember to download the appropriate version of `adios4dolfinx` from Github [adios4dolfinx: Releases](https://github.com/jorgensd/adios4dolfinx/releases)

To run the test suite, you should also install `ipyparallel`, `pytest` and `coverage`, which can all be installed with conda

```bash
conda install -c conda-forge ipyparallel pytest coverage
```

## Functionality

Expand Down