Skip to content

Commit

Permalink
Update required nomad-lab version and add warning to README (#86)
Browse files Browse the repository at this point in the history
* Added index url instructions to README.md

* Update required nomad-lab version to 1.3.6
  • Loading branch information
hampusnasstrom authored Sep 13, 2024
1 parent 6ddd95e commit b6f5f12
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,13 @@ This is a plugin for [NOMAD](https://nomad-lab.eu) which contains base sections
material processing.

## Getting started
`nomad-material-processing` can be installed from PyPI using `pip`:
`nomad-material-processing` can be installed from PyPI using `pip`.

> [!WARNING]
> Unfortunately, the current plugin mechanism is not supported by the latest nomad-lab version on PyPI and therefore an index url pointing to the NOMAD Gitlab registry needs to be added.
```sh
pip install nomad-material-processing
pip install nomad-material-processing --index-url https://gitlab.mpcdf.mpg.de/api/v4/projects/2187/packages/pypi/simple
```

### Setting up your OASIS
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ authors = [
]
license = { file = "LICENSE" }
dependencies = [
"nomad-lab>=1.3.4dev",
"nomad-lab>=1.3.6",
]

[project.urls]
Expand Down

0 comments on commit b6f5f12

Please sign in to comment.