how to write a nomad analytics tutorial

This tutorial gives a short overview on how to create your own Nomad Beaker Notebooks and on how to comply to the current cooperate design and branding of the Nomad Laboratory group.

Setup

Start your project in a separate nomad-lab repository prefixed by the string "notebook-". Please choose a meaningful lowercase name and concatenate separated words with a hyphen. You may use a slugify generator (https://blog.tersmitten.nl/slugify) to comply to the format. A good repository name is "notebook-periodic-table" and a bad one is "notebook-pt".

Structure

Structure your repository as seen in the following, where "notebook-nomad-template" is the name of the imaginary Beaker notebook we want to create:

notebook-nomad-template
├── beaker-notebooks
│   └── notebook-nomad-template.bkr
├── example-data
│   └── notebook-nomad-template
├── LICENSE
├── README.md
└── requirements.txt

For your convenience, there already exists some files you can directly use for your own projects.

1. a default Nomad Beaker Notebook Template (download) that will be updated regularly. Thus, you don't have to start from scratch and you can start coding. You only have to replace all the place-holders given in the notebook and that's it.

2. a pre-made LICENSE file (download) that can directly be copied into your project. By default, we use the Apache License 2.0 license. A nice overview of the licence conditions gives https://choosealicense.com/licenses/apache-2.0/ .

The requirements.txt file is there if you need special python libraries for your notebook, i.e., numpy, that can be installed via pip (https://pypi.python.org/pypi). Please list the needed libraries as a plain text file with one library name per line.

If you need additional files, please store them in the example-data/notebook-nomad-template folder.

Release

Once you have finished your notebook and it was reviewed by your supervisor(s) or group members, you are ready to put all your files into the [Nomad Analytics Toolkit Tutorials repository] (https://gitlab.rzg.mpg.de/nomad-lab/analytics-toolkit-tutorials). In this case, copy the example-data/notebook-nomad-template folder into the repository's example-data folder and your notebook into the repository's beaker-notebook folder. You may adjust your paths in your notebook and do a commit.

• notebook-nomad-template.bkr v1.1.0
• LICENSE