Get Started

Get access

If you see this page you should already have access. To know how you did (for the next one?) see the Getting Access wiki page.

Scala (and python)

The development happens mostly in python and scala. For scala we wrote a small document to get started with scala.

Git Repositories

You can get the main git repository with

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

the metadata description repository is at

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

The main git repository (nomad-lab-base) contains submodules (nomad-meta-info etc.), hence the --recursive option is required during clone. If you clone the main git repository without the --recursive option, then you can initialize the submodules with

 git submodule update --init

This command initializes your local configuration file and then fetches the submodule. More information on submodule can be found on Git Tools: Submodules

You may use https instead of ssh:

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

Setup

From here see the Setup.markdown file, and if you are a parser developer how to write a parser.

Contributing

You may not have authorization to directly push your changes to the git repositories. In this case to contribute to the project you can

1. Fork the desired repository.
2. Commit and Push changes to the forked repository.
3. Create a merge request.

The merge request in GitLab is same as the pull request in GitHub or Bitbucket. More information on the merge request can be found at GitLab workflow and GitHub pull request. For example, to create a merge request, go to the forked repository and create a merge request to using the "new merge request" option. This option is available in "+" next to the repository git/https url.