NOMAD How-to guides

Users

These how-to guides target NOMAD users and cover data management, exploration, analysis with NOMAD graphical web-interface and APIs.

Manage and find data

Use NOMAD to manage, explore, and analyze data.

• Upload and publish data for supported formats
• Use ELNs
• Explore data
• Use NORTH

Programmatic use

Use NOMAD's functions programmatically and via its APIs.

• Use the API
• Publish data using python
• Install nomad-lab
• Access processed data
• Transform data

Data stewards, administrators, and developers

These how-to guides allow advanced users, NOMAD administrators, data stewards, and developers to customize and operate NOMAD and NOMAD Oasis or contribute to NOMAD's development.

NOMAD Oasis — self-hosting

Self-hosting NOMAD for your lab or institution.

• Configure an Oasis
• Deploy an Oasis
• Update an Oasis
• Perform admin tasks

Plugins

Learn how to write NOMAD plugins.

• Introduction to plugins
• Write an API
• Write an app
• Write an example upload
• Write a normalizer
• Write a parser
• Write a schema packages

Customization

Customize NOMAD and tailor NOMAD Oasis.

• Write a schema
• Define ELNs
• Use base sections
• Parse tabular data
• Define workflows
• Work with units
• Use HDF5 to handle large quantities
• Use Mapping parser to write data on archive

Development

Become a NOMAD developer and contribute to the source code.

• Get started
• Navigate the code
• Contribute
• Extend the search

One last thing

If you can't find what you're looking for in our guides, contact our team for personalized help and assistance. Don't worry, we're here to help and learn what we're doing wrong!