How fairmat-nfdi/pynxtools works
pynxtools combines instrument data and ELN metadata into NeXus-compliant HDF5, with validation and schema-aware inspection; it also integrates NeXus data with NOMAD for search and publication. The main conversion flow is documented in the README, and indexed source references support several internal links. Some converter and NOMAD relationships are inferred from those references rather than complete excerpts, so the graph omits uncertain wiring.
Main entry points: convert.py Converter · parser_v2.py NOMAD parser · validation.py Validation · schema_resolver.py Schema resolver
Components 17
Data conversion
- Converter
src/pynxtools/dataconverter/convert.py - Multi reader
src/pynxtools/dataconverter/readers/multi/reader.py - JSON map reader
src/pynxtools/dataconverter/readers/json_map/reader.py - Template mapping
src/pynxtools/dataconverter/template.py - Validation
src/pynxtools/dataconverter/validation.py - HDF5 writer
src/pynxtools/dataconverter/writer.py
NeXus schema and tools
- Schema tree
src/pynxtools/nexus/nexus_tree.py - Schema resolver
src/pynxtools/nexus/schema_resolver.py - NeXus visitor
src/pynxtools/nexus/handler.py - File annotator
src/pynxtools/annotator/annotator.py
ELN mapping
- ELN mapper
src/pynxtools/eln_mapper/eln.py
NOMAD integration
- NOMAD parser
src/pynxtools/nomad/parsers/parser_v2.py - NOMAD schema
src/pynxtools/nomad/schema_packages/schema.py - NeXus annotations
src/pynxtools/nomad/annotations.py
Other components
- Data user
- NeXus HDF5
- NOMAD archive
Connections 18
- Data user → Converter: runs conversion
- Converter → Multi reader: loads reader
src/pynxtools/dataconverter/convert.py - Multi reader → JSON map reader: dispatches to
src/pynxtools/dataconverter/readers/multi/reader.py - Converter → Template mapping: uses mapping
src/pynxtools/dataconverter/convert.py - Converter → Validation: validates data
src/pynxtools/dataconverter/convert.py - Converter → HDF5 writer: writes output
src/pynxtools/dataconverter/convert.py - HDF5 writer → NeXus HDF5: writes HDF5
- Validation → Schema tree: checks structure
src/pynxtools/dataconverter/validation.py - Validation → Schema resolver: resolves schema
src/pynxtools/dataconverter/validation.py - File annotator → NeXus visitor: visits file
src/pynxtools/annotator/annotator.py - File annotator → Schema resolver: resolves concepts
src/pynxtools/annotator/annotator.py - ELN mapper → Converter: supplies metadata
- NOMAD parser → NeXus visitor: traverses HDF5
src/pynxtools/nomad/parsers/parser_v2.py - NOMAD parser → Schema resolver: resolves fields
src/pynxtools/nomad/parsers/parser_v2.py - NOMAD parser → NeXus annotations: reads annotations
- NOMAD schema → NeXus annotations: defines schema
- NOMAD parser → NOMAD archive: populates archive
- NOMAD schema → NOMAD archive: enables integration