How-to guides

How-to guides are goal-oriented instructions. Use them when you need to complete a specific task.

Tasks by area

Manage and find data

Complete day-to-day tasks for managing, exploring, and analyzing data.

• With the GUI
  • Create an account and sign in
  • Create and publish Projects
  • Import data from external ELNs
  • Analyze data in NORTH
  • Create custom workflows
• Work programmatically
  • Use the API
  • Authenticate programmatically
  • Download data
  • Publish data using Python
  • Access processed data
  • Transform JSON data structures
  • Make Graph API calls

Work with schemas

Define how your data is structured, in YAML or in Python, and keep those definitions maintainable.

• Start working with schemas
• Define a schema
• Parse tabular data
• Handle schema evolution
• Advanced schema concepts

Develop plugins

Extend NOMAD with Python-based plugins and their entry points.

• Start plugin development
• Create entry points
  • Actions
  • APIs
  • Apps
  • Dashboards
  • Example uploads
  • Normalizers
  • NORTH tools
  • Parsers
  • Schema packages
• Use built-in tools
  • Work with units
  • Handle large data
  • Parse efficiently

Host a NOMAD Oasis

Install and operate a NOMAD deployment for a lab or institution.

• Install
• Configure
• Deploy
• Administer
• Secure
• Troubleshoot
• Migrate
  • Overview
  • NOMAD 2.0
  • NOMAD 1.4.2
  • NOMAD 1.2.2
  • NOMAD 1.2.0
  • NOMAD 0.8.x to 1.x

Develop the core software

Work on the nomad-lab codebase and contribute changes upstream.

• Get started
• Navigate the code
• Contribute
• Write a normalizer
• Extend the search
• Make a release
• Add a new type

Related materials

• For guided learning experiences, see Tutorials > Overview.
• For conceptual background, see Explanation > Overview.
• For authoritative technical details, see Reference > Overview.