hsd-data

User Documentation

  • Installation
    • Requirements
      • Optional Dependencies
    • Building with CMake
      • Minimal Build
      • Full Build (all backends)
      • CMake Options
    • Using as a Dependency
      • CMake FetchContent
      • Local Subdirectory
    • Verifying the Installation
  • User Guide
    • Overview
    • Loading Data
      • From a File
      • With Explicit Format
      • From a String
      • With Root Wrapping
    • Dumping Data
      • To a File
      • To a String
      • Pretty vs Compact Output
    • Converting Between Formats
      • Programmatic
      • Command Line
    • Working with the Tree
    • Format Detection
    • Error Handling
      • Status Codes
    • Backend-Specific Access
  • Format Mapping
    • Core Concepts
    • HSD ↔ XML
      • Table Nodes
      • Value Nodes
      • Attributes
      • Anonymous Values
    • HSD ↔ JSON
      • Table Nodes
      • Value Nodes
      • Arrays
      • Attributes
      • Anonymous Values
    • HSD ↔ YAML
      • Table Nodes
      • Value Nodes
      • Arrays
      • Attributes
      • Anonymous Values
    • HSD ↔ TOML
      • Table Nodes
      • Value Nodes
      • Arrays
      • Attributes
      • Complex Values
    • HSD ↔ HDF5
      • Table Nodes
      • Value Nodes
      • Attributes
    • Round-Trip Considerations
      • Lossless Round-Trips
      • Potentially Lossy Conversions
  • CLI Tool: hsd-convert
    • Usage
    • Examples
      • File-to-File (auto-detected formats)
      • Explicit Format Override
      • Compact Output
      • Stdin/Stdout
    • Options
    • Format Identifiers
    • Exit Codes
    • Building

Reference

  • API Reference
    • Unified IO
      • data_load
      • data_load_string
      • data_dump
      • data_dump_to_string
      • data_convert
    • Format Constants
    • Utilities
      • data_detect_format
      • data_format_available
    • Backend-Specific Functions
      • HSD Backend
      • XML Backend
      • JSON Backend
      • YAML Backend
      • TOML Backend (optional)
    • Re-exported hsd-fortran API
      • Types
      • Constructors
      • Accessors
      • Mutators
      • Query
      • Validation
      • Schema
      • Attributes
      • Status Codes
      • Value Type Constants
hsd-data
  • Search

© Copyright 2026, DFTB+ developers group.

Built with Sphinx using a theme provided by Read the Docs.