NOMAD How-to guides

Manage and find data

These how-to guides cover every-day NOMAD usage including data management, exploration, and analysis with NOMAD's graphical user interface and APIs.

With the GUI

Use NOMAD to manage, explore, and analyze data.

• Upload and publish data for supported formats
• Enter data with ELNs
• Explore data
• Analyze data in NORTH
• Create custom workflows
• Write a YAML schema package
• Create custom ELNs
• Parse tabular data

Programmatically

Use NOMAD's functionalities programmatically.

API Overview

• Download data
• Publish data using Python
• Access processed data
• Transform data
• Make graph-style API calls

Develop plugins

These how-to guides direct advanced users, data stewards, and NOMAD application administrators to build robust and powerful customized NOMAD support with Python-based plugin software.

Plugins Overview

Entry point types

NOMAD plugins are connect with the core software via "entry points". There are various types of entry points, with specific roles within the infrastructure for providing support for data ingestion, visualization, search, and more:

• APIs
• Apps
• Example uploads
• Normalizers
• Parsers
• Schema packages

Built-in tools

NOMAD's built-in tools ease the plugin development process and help to ensure standardization and efficiency of plugins.

• Work with units
• Handle large data with HDF5
• Parse efficiently with mapping annotations

Host a NOMAD Oasis

These how-to guides provide technical guidelines for system adminstrators to setup, deploy, and maintain a local installation of NOMAD.

Host a NOMAD Oasis for your lab or institution.

• Install
• Configure
• Deploy
• Update
• Administer

Develop the core software

These how-to guides provide technical guidelines for developers of the core NOMAD software.

Contribute to the core NOMAD software.

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

Additional Resources

Support Page