nomad logo NOMAD
Developer Overview
Everything you need to build on NOMAD or contribute back to it — where the code lives, how it is licensed, and how to get changes reviewed and merged.
NOMAD is open source
NOMAD is an open project. There are many ways to support us and contribute to further developments.
Apache 2.0

We use a permissive license so that you can use NOMAD everywhere and for all purposes.

Discuss

Openly discuss problems and opportunities and participate in the design of a future NOMAD.

Contribute

Contribute bugfixes, features, and extensions via standard open source workflows.

Source code repositories
The NOMAD software consists of many parts and is maintained in several source code repositories.

GitLab@MPCDF

The main GitLab project hosted by the Max-Planck Computing and Data Facility (MPCDF). It is used by the FAIRmat and NOMAD team members.

  • For official team members
  • Openly readable
  • Runs all CI/CD pipelines
  • Released packages and images

GitHub

This is a public version of the main repository hosted at GitHub. It contains the latest develop branch. This is aimed at the wider community.

  • For everyone
  • Create your own forks
  • Create issues and pull requests
  • Leave a star

Parsers at GitHub

Some components, e.g. all the parsers, are maintained in separate git projects. Those are hosted at GitHub in the nomad-coe GitHub organization.

  • For parser related problems
  • Room for future plug-ins
  • Other related software
  • For NOMAD and NOMAD CoE