Reference

Reference pages provide authoritative technical details. Use them when you need exact syntax, definitions, options, or generated reference material.

Topics

• REST API: the built-in NOMAD API: resources, requests, queries, pagination, errors, and API usage limits.
• ArchiveQuery client: the Python ArchiveQuery client: options, methods, result formats, and transfer behavior.
• Schema language: the Metainfo schema language: definition attributes, quantity types, and conventions.
• Configuration: deployment and application configuration options.
• Annotations: metainfo annotations and their arguments.
• JSON transformer: fields of JSON transformation rules and arguments of the Transformer.
• Base sections: generated reference for NOMAD base sections.
• CLI: command-line interface reference.
• Plugins: plugin reference material.
• Code guidelines: coding conventions used in NOMAD.
• Glossary: shared terminology used across the documentation.
• Tutorial catalog: an index of tutorial and training resources.

Related materials

• For guided learning experiences, see Tutorials > Overview.
• For task-oriented instructions, see How-to guides > Overview.
• For conceptual background, use Explanation > Overview.