Skip to content

Commit

Permalink
Clarified the toml plugin inclusion
Browse files Browse the repository at this point in the history
  • Loading branch information
hampusnasstrom committed Sep 30, 2024
1 parent fdfd8f0 commit 44aecd6
Showing 1 changed file with 20 additions and 8 deletions.
28 changes: 20 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,26 +129,38 @@ To add a new plugin to the docker image you should add it to the plugins table i
Here you can put either plugins distributed to PyPI, e.g.
```
nomad-material-processing
```toml
[project.optional-dependencies]
plugins = [
"nomad-material-processing>=1.0.0",
]
```
or plugins in a git repository with either the commit hash
```
"nomad-measurements @ git+https://github.com/FAIRmat-NFDI/nomad-measurements.git@71b7e8c9bb376ce9e8610aba9a20be0b5bce6775"
```toml
[project.optional-dependencies]
plugins = [
"nomad-measurements @ git+https://github.com/FAIRmat-NFDI/nomad-measurements.git@71b7e8c9bb376ce9e8610aba9a20be0b5bce6775",
]
```
or with a tag
```
"nomad-measurements @ git+https://github.com/FAIRmat-NFDI/[email protected]"
```toml
[project.optional-dependencies]
plugins = [
"nomad-measurements @ git+https://github.com/FAIRmat-NFDI/[email protected]"
]
```
To add a plugin in a subdirectory of a git repository you can use the `subdirectory` option, e.g.
```
"ikz_pld_plugin @ git+https://github.com/FAIRmat-NFDI/AreaA-data_modeling_and_schemas.git@30fc90843428d1b36a1d222874803abae8b1cb42#subdirectory=PVD/PLD/jeremy_ikz/ikz_pld_plugin"
```toml
[project.optional-dependencies]
plugins = [
"ikz_pld_plugin @ git+https://github.com/FAIRmat-NFDI/AreaA-data_modeling_and_schemas.git@30fc90843428d1b36a1d222874803abae8b1cb42#subdirectory=PVD/PLD/jeremy_ikz/ikz_pld_plugin"
]
```
Once the changes have been committed to the main branch, the new image will automatically
Expand Down

0 comments on commit 44aecd6

Please sign in to comment.