Skip to content
Snippets Groups Projects

Fixed typos and some language in the plugin docs.

Merged Lauri Himanen requested to merge 1418-plugin-documentation-typo-fix into 1008-plugin-mechanism
1 file
+ 4
4
Compare changes
  • Side-by-side
  • Inline
+ 4
4
@@ -66,7 +66,7 @@ metadata that is necessary to use them. See below for a reference of the *plugin
models.
The file `nomad.yaml` shows how to add the plugin to a nomad installation. As a plugin
develop you have (installed our Python package)[./pythonlib.md] and can run the `nomad parse`
developer you have [installed our Python package](./pythonlib.md) and can run the `nomad parse`
command as your "installation" to try your schema:
```yaml
@@ -86,14 +86,14 @@ each `options` entry with `python_package` will be merged with the data in the p
Please note that `python_package` is the name of a Python package and not a path to the
code. This also means that the package has to be in your `PYTHONPATH` (see below).
Now follow the instructions for on of our examples and try for yourself:
Now follow the instructions for one of our examples and try for yourself:
- [schema plugin](https://github.com/nomad-coe/nomad-schema-plugin-example)
- [parser plugin](https://github.com/nomad-coe/nomad-parser-plugin-example)
## Add a plugin to your NOMAD (Oasis)
To add a plugin, you need to add the *plugin metadata* the the `nomad.yaml` and you need
To add a plugin, you need to add the *plugin metadata* to `nomad.yaml` and you need
to add the *plugin code* to the `PYTHONPATH` of your NOMAD. The `nomad.yaml` needs to be
edited manually in the usual way. There are several ways to
add *plugin code* to a NOMAD installation:
@@ -108,4 +108,4 @@ add *plugin code* to a NOMAD installation:
coming soon...
We plan to provide a plugin registry that allows you to publish your plugin's *metadata*.
This can then be used to simplyfy the adding of existing plugins to a NOMAD installation.
\ No newline at end of file
This can then be used to simplify plugin management within a NOMAD installation.
\ No newline at end of file
Loading