Skip to content

Commit

Permalink
Clarify use of include and exclude
Browse files Browse the repository at this point in the history
  • Loading branch information
ndaelman committed Apr 9, 2024
1 parent cb98980 commit 26b3ec6
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,17 +71,18 @@ description: |
This is a collection of NOMAD schemas for simulation data.
```
and define the ```nomad.yaml``` configuration file of your NOMAD instance in the root folder with the following content:
and register the plugin in the ```nomad.yaml``` configuration file of your NOMAD root folder:

```yaml
plugins:
include:
- schemas/nomad_simulations
options:
schemas/nomad_simulations:
python_package: nomad_simulations
```

If you want to administer your plugins, you can use `include` or `exclude` flags.
ATTENTION: when using `include`, any plugin not specified will not be loaded.

You also need to add the package folder to the `PYTHONPATH` of the Python environment of your local NOMAD installation. This can be done by specifying the relative path to this repository. Either run the following command every time you start a new terminal for running the appworker, or add it to your virtual environment in `<path-to-local-nomad-installation>/.pyenv/bin/activate` file:

```sh
Expand Down

0 comments on commit 26b3ec6

Please sign in to comment.