setup.md

How to get started in development

This is a step-by-step guide to get started with NOMAD development. You will clone all sources, set up a Python and Node.js environment, install all necessary dependencies, run the infrastructure in development mode, learn to run the test suites, and set up Visual Studio Code for NOMAD development.

This is not about working with the NOMAD Python package nomad-lab. You can find its documentation here.

Clone the sources

If not already done, you should clone NOMAD. If you have an account at the MPDCF Gitlab{:target="_blank"}, you can clone with the SSH URL:

git clone git@gitlab.mpcdf.mpg.de:nomad-lab/nomad-FAIR.git nomad

Otherwise, clone using the HTTPS URL:

git clone https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-FAIR.git nomad

Then change directory to nomad

cd nomad