Skip to content

How to install this plugin

This plugin can be used in a NOMAD Oasis installation. Please visit the NOMAD documentation for details on how to setup an NOMAD Oasis.

Add This Plugin to Your NOMAD Oasis installation

Read the NOMAD plugin documentation for all details on how to deploy the plugin on your NOMAD instance.

We recommend writing your own NOMAD docker image which includes the NOMAD plugins you want to deploy. Please follow these instructions to set up your own NOMAD image writing workflow.

You need to modify the plugins.txt file and add the following lines:

nomad-measurements

This will add the latest version of the NOMAD-measurements Plugin to your NOMAD Oasis image. If you want to add a specific version of the plugin you will need to provide the specific version tag or commit sha, for example:

nomad-measurements==0.1.0
or
git+https://github.com/FAIRmat-NFDI/nomad-measurements.git@f19c0e3b175613ec026ef36c849af3474c42cf52

Local installation of the plugin in your Python environment

nomad-measurements can be installed from PyPI using pip. Currently we require features in nomad-lab which are not published to PyPI. In order to install these a --index-url needs to be provided:

pip install nomad-measurements --index-url https://gitlab.mpcdf.mpg.de/api/v4/projects/2187/packages/pypi/simple