NOMAD Tutorials¶
This section of the documentation provides practical, hands-on instructions for working with NOMAD. These tutorials are designed to guide you through specific tasks while focusing on key learning outcomes. They provide a structured learning experience that helps you apply concepts to real-world scenarios while reinforcing your knowledge.
As you go through the tutorial pages, you will encounter embedded boxes with different colors and icons, each providing distinct types of information or instructions. Below is a list of the various box types and guidance on how to use them:
Offers additional information to enhance your understanding of NOMAD.
Presents hands-on tasks or questions with instructions to complete them.
Shares example files for you to try out, along with explanations of their contents and scientific use cases.
Displays important warnings to consider before proceeding further in the tutorial.
Scope of the Tutorials¶
NOMAD is available in two flavours to address the diverse needs of scientists: Central NOMAD and NOMAD Oasis. To learn more about these solutions, refer to our web page.
Our tutorial documentation covers the basics of using Central NOMAD and NOMAD Oasis. These tasks range from basic operations using the graphical user interface (GUI), to low-barrier tailoring of electronic lab notebooks, and robust customization with plugins.
Tutorial Topics¶
- Create a NOMAD upload and share it with your colleagues.
- Add research data files to the upload and create entries.
- Create datasets and publish them with a DOI.
- Find and access data using the search interface and the filter sidebar.
- Create custom widgets for a personalized search experience.
- Use the NOMAD domain-specific apps.
- Create an ELN using the built-in NOMAD templates.
- Add entries for samples, instruments, processes, and more.
- Explore and search your ELN.
Managing workflows and projects
- Organize and manage complex research workflows using NOMAD.
- Interface with NOMAD programmatically for automation and high-throughput use.
- Create simple requests using the NOMAD API.
- Create a custom NOMAD ELN schema using YAML files.
- Create a parser for your tabular data (.xls or .csv).
- Use the NOMAD GitHub template to create plugins.
- Install plugins to your NOMAD Oasis.
User Skill Levels¶
An overview of the skills required to use NOMAD and NOMAD Oasis, categorized into basic use, customization, and self hosting, is presented in the figure below.
Ways to Access NOMAD¶
There are multiple access points to NOMAD. The general landing page provides an overview of NOMAD’s features, along with links to documentation, tutorials, and project history.
From this page, we can navigate to NOMAD to upload, manage, and explore data.
Two public versions that are relevant to the tutorials are:
-
Official – The latest stable version of NOMAD.
Access it by clicking the "Open NOMAD" button at the top of the landing page.
-
Test – Runs the latest released version of NOMAD but on temporary test data that is routinely wiped.
Access it from the Installations menu at the bottom of the landing page by selecting "Test."
These tutorials are based on the official version of NOMAD. All instructions are based on it unless stated otherwise.
Create a NOMAD User Account¶
A NOMAD user account is required if you want to upload, share, publish, or analyze your data. However, exploring data in NOMAD does not require an account. Creating a NOMAD user account is quick and free!
Use the arrow buttons ⬅️➡️ below to slide through the steps and create a NOMAD account.
Login Options via Helmholtz AAI¶
You can also log in to NOMAD using your university or research institute credentials, or with social accounts such as GitHub, ORCID, or Google via the Helmholtz AAI (Authentication and Authorization Infrastructure).
To sign in, select the Helmholtz AAI option in the login form, then choose your institution or preferred social account from the list.
You will be redirected to your institution’s login page, where you can enter your credentials securely.
Helmholtz AAI ensures secure and privacy-compliant authentication 🔒. Most major universities and research institutions in Germany and across Europe are supported.
Use the arrow buttons ⬅️➡️ below to see how to sign in via Helmholtz AAI.
