Skip to content

How to install a NOMAD Oasis

NOMAD software is Open-Source, and everybody can run it. A self-hosted instance is called a NOMAD Oasis. A NOMAD Oasis does not need to be fully isolated. For example, you can publish uploads from your NOMAD Oasis to the central NOMAD installation. A NOMAD Oasis can be installed on a wide variety of different platforms: from your local laptop to a kubernetes cluster running in the cloud. We also support the three major operating systems: Linux, Windows and macOS.

The entire setup for a running a NOMAD Oasis is contained in a Git repository, and is called a NOMAD distribution. We provide different distribution templates to help you get started:

  1. NOMAD distribution for production

    For installing a production-ready, self-hosted NOMAD Oasis for research groups or institutions.

  2. NOMAD distribution for development

    Specialized template that allows for a much faster development cycle. This is targeted for plugin developers, Oasis administrators and for developing the nomad-lab package. Should not be used in production.

Once you have created a distribution, you can proceed to learning more about the different configuration options, different ways to deploy your distribution, and also about how to update, administer or troubleshoot your Oasis.

Note

If you are installing a NOMAD Oasis, please register your Oasis with FAIRmat. This allows us to contact you for important updates and helps us keep track of the number and location of installations.

How to install the NOMAD Python Library

The nomad-lab Python package contains the core software features of the NOMAD software, including the API, CLI, upload processing routines etc. This Python package is installed automatically as part of a NOMAD Oasis, but you can optionally install and use it as a stand-alone library for tasks like parsing or programmatic data querying.

You can install the latest stable version from PyPI:

pip install nomad-lab

or alternatively use our own GitLab package registry to download a more recent development version:

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

The Python package offers different feature sets through optional dependencies:

pip install nomad-lab[parsing]        # For parsing functionality (includes HDF5, netCDF, ASR parsers)
pip install nomad-lab[infrastructure] # For running the NOMAD infrastructure
pip install nomad-lab[dev]            # Contains development tools (pytest, pylint, mypy)

The nomad-lab package and it's dependencies can run natively on Linux, Windows and macOS.