This is a plugin for NOMAD which contains base sections for materials science measurements.
The nomad_measurements.xrd
module supports
parsing of following vendor-specific file formats:
-
.rasx
(Rigaku) -
.xrdml
(Malvern Panalytical) -
.brml
(Bruker)
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
Read the NOMAD plugin documentation for all details on how to deploy the plugin on your NOMAD instance.
You don't need to modify the nomad.yaml
configuration file of your NOMAD instance, beacuse the package is pip installed and all the available modules (entry points) are loaded.
To include, instead, only some of the entry points, you need to specify them in the include
section of the nomad.yaml
. In the following lines, a list of all the available entry points:
plugins:
include:
- "nomad_measurements.general:schema"
- "nomad_measurements.xrd:schema"
- "nomad_measurements.xrd.parser:parser"
- "nomad_measurements.transmission:schema"
- "nomad_measurements.transmission:parser"
This code is currently under development and for installing and contributing you should clone the repository:
git clone git@github.com:FAIRmat-NFDI/nomad-measurements.git
cd nomad-measurements
And install the package in editable mode with the development ('dev') dependencies:
pip install -e .[dev] --index-url https://gitlab.mpcdf.mpg.de/api/v4/projects/2187/packages/pypi/simple