Skip to content

Install the Python library

NOMAD provides a Python package called nomad-lab. The package is hosted on pypi and you can install it with pip (or conda).

To install the latest stable pypi release, simply use pip:

pip install nomad-lab

Attention

Since NOMAD v1 is still in beta, there is no official pypi release. pip install will still give you the Python library for the NOMAD v0.10.x version.

To install the latest release developer release (e.g. v1) from our servers use:

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

There are different layers of dependencies that you have to install, in order to use certain functions of NOMAD. The base install above, only installs the necessary packages for accessing the NOMAD Archive and using the NOMAD metainfo (see access the archive).

Other functions, e.g. using the NOMAD parsers to parse your code output, require additional dependencies. You can use the [extra] notation to install these extra requirements:

pip install nomad-lab[parsing]
pip install nomad-lab[infrastructure]
pip install nomad-lab[dev]
pip install nomad-lab[all]
The various extras have the following meaning:

  • parsing, everything necessary to run the parsers

  • infrastructure, everything to run NOMAD services

  • dev, additional tools that are necessary to develop NOMAD

  • all, all of the above