Hadros Logo

Contents

  • 1. Overview and Quick Start
    • 1.1. Package at a Glance
    • 1.2. Build and Test
    • 1.3. Minimal Library Example
    • 1.4. Scientific Inputs and Generated Outputs
    • 1.5. First Run
    • 1.6. Reading the Manual
  • 2. New User Workflow
    • 2.1. The Data Flow
    • 2.2. Build the Package
    • 2.3. Annotated Templates
    • 2.4. Sigma Two-Body Example
      • 2.4.1. Inspect the Catalog
      • 2.4.2. Survey Thresholds and Targets
      • 2.4.3. Generate the Coupled Basis
    • 2.5. Roper Two- and Three-Body Example
      • 2.5.1. Generate and Validate the Combined Basis
    • 2.6. Channel Selection and Validation
    • 2.7. Consume a Basis from C++
    • 2.8. Common Mistakes
  • 3. Hadron Catalogs and Quantum Numbers
    • 3.1. The Hadron Class
    • 3.2. Doubled Quantum Numbers
    • 3.3. Hadron XML Fields
    • 3.4. Basis, Metadata, and Units
    • 3.5. Charge Conjugation
    • 3.6. Using Catalogs from C++
  • 4. Multi-Hadron States
    • 4.1. Compositions and Thresholds
    • 4.2. Flavor-First Target Discovery
    • 4.3. One-Hadron States
    • 4.4. Two-Hadron States
    • 4.5. Three-Hadron States
    • 4.6. Target Sectors
    • 4.7. Higher-Multiplicity Thresholds
  • 5. Channel Spaces
    • 5.1. One-Hadron Channels
    • 5.2. Two-Hadron Channels
    • 5.3. Pair-Spectator Channels
    • 5.4. G-Parity Projection
    • 5.5. Channel Bases
    • 5.6. Construction and Lookup
    • 5.7. Stable Channel Identity
    • 5.8. Generation and Validation
    • 5.9. Current Boundary
  • 6. XML and Command Reference
    • 6.1. Canonical XML Policy
    • 6.2. Hadron Catalog Schema
    • 6.3. Flavor-Sector Search Schema
    • 6.4. Strict Shape Validation
    • 6.5. Target Schema
    • 6.6. Channel Schema
    • 6.7. Catalog Commands
    • 6.8. Target Commands
    • 6.9. Threshold and Channel Reports
    • 6.10. Channel Database Validation
    • 6.11. Recommended File Discipline
  • 7. Validation, Errors, and Reproducibility
    • 7.1. Validation Layers
    • 7.2. Single-Hadron Invariants
    • 7.3. Target-Sector Invariants
    • 7.4. Channel-Basis Invariants
    • 7.5. Exceptions in the C++ API
    • 7.6. Command-Line Failure Behavior
    • 7.7. Reviewing Scientific Inputs
    • 7.8. Limits of Validation
  • 8. Building and Integration
    • 8.1. Requirements
    • 8.2. Source Tree
    • 8.3. Recommended Local Build
    • 8.4. Custom Build Directory
    • 8.5. Choosing a Compiler
    • 8.6. Manual CMake Build
    • 8.7. Compiled Teaching Examples
    • 8.8. Building Documentation Manually
    • 8.9. Installing Hadros
    • 8.10. Using an Installed Package
    • 8.11. Using Hadros as Source
    • 8.12. CMake Options
    • 8.13. Version Compatibility
  • 9. API Reference
    • hadros
      • OneHadronChannelBasis
      • TwoHadronChannelBasis
      • PairSpectatorChannelBasis
      • FlavorBasis
        • su2
      • channel_id()
      • channel_id()
      • channel_id()
      • find_channel_index()
      • find_channel_index()
      • find_channel_index()
      • make_one_hadron_channel_basis()
      • make_one_hadron_channel_bases()
      • make_two_hadron_channel_basis()
      • make_two_hadron_channel_bases()
      • make_pair_spectator_channel_basis()
      • make_pair_spectator_channel_bases()
      • make_channel_space()
      • make_channel_spaces()
      • conjugate_name()
      • conjugate()
      • missing_conjugates()
      • target_quantum_numbers()
      • validate_target_quantum_numbers()
      • validate_target_sector()
      • is_neutral_mesonic_total()
      • is_neutral_mesonic_total()
      • label()
      • id()
      • exchange_symmetry_allowed()
      • two_body_g_parity()
      • label()
      • id()
      • label()
      • id()
      • label()
      • id()
      • label()
      • id()
      • operator<<()
      • operator<<()
      • generate_targets()
      • diff_hadron_catalogs()
      • enumerate_two_hadron_channels()
      • matches_target()
      • matches_target()
      • enumerate_two_hadron_channels()
      • enumerate_pair_spectator_channels()
      • enumerate_pair_spectator_channels()
      • operator<<()
      • label()
      • parse_flavor_basis()
      • g_parity_action()
      • survives_g_parity_projection()
      • operator<<()
      • matches_target()
      • matches_target()
      • match_hadrons()
      • validate_database_metadata()
      • merge_database_metadata()
      • validate_metadata_compatibility()
      • operator<<()
      • display_half_integer()
      • display_sign()
      • display_spin_parity()
      • display_isospin_g()
      • display_spin_parity_c()
      • display_naturality()
      • mass_column()
      • igjp_column()
      • flavor_charge_column()
      • hadron_table()
      • phase_factor()
      • is_pm_one()
      • allowed_couplings()
      • coupling_allows()
      • half_integer_label()
      • parse_half_integer_label()
      • pmz_label()
      • signed_label()
      • orbital_letter()
      • two_l_from_letter()
      • label()
      • possible_sectors()
      • possible_sectors()
      • operator<<()
      • validate_flavor_sector_search()
      • validate_resolved_flavor_sector_search()
      • read()
      • write()
      • read()
      • write()
      • read()
      • write()
      • read()
      • write()
      • read_hadron_catalog()
      • load_hadron_catalog()
      • write_hadron_catalog_string()
      • read()
      • write()
      • read_flavor_sector_database()
      • load_flavor_sector_database()
      • write_flavor_sector_database_string()
      • read()
      • write()
      • read()
      • write()
      • read_target_database()
      • load_target_database()
      • write_target_database_string()
      • write_channel_spaces_string()
      • write_channel_bases_string()
      • write_channel_bases_string()
      • read_channels()
      • load_channels()
      • read_two_hadron_channel_bases()
      • read_pair_spectator_channel_bases()
      • load_two_hadron_channel_bases()
      • load_pair_spectator_channel_bases()
      • hadros::ChannelBasis
        • ChannelBasis()
        • ChannelBasis()
        • ChannelBasis()
        • ChannelBasis()
        • ChannelBasis()
        • target()
        • entries()
        • size()
        • empty()
        • at()
        • channel()
        • id()
        • find_id()
        • channels()
      • hadros::ChannelSpace
        • ChannelSpace()
        • ChannelSpace()
        • target()
        • one_body()
        • two_body()
        • three_body()
      • hadros::DatabaseMetadata
        • operator==()
        • energy_unit
        • ensemble
      • hadros::Flavor
        • Flavor()
        • Flavor()
        • two_i()
        • g_parity()
        • baryon_number()
        • strangeness()
        • charm()
        • bottom()
        • hypercharge()
        • c_parity()
        • has_neutral_additive_charges()
        • is_neutral_mesonic()
        • is_self_conjugate()
        • is_conjugate_of()
        • conjugated()
        • label()
        • operator<=>()
        • operator==()
      • hadros::FlavorSectorDatabase
        • operator==()
        • flavor_basis
        • metadata
        • sectors
      • hadros::FlavorSectorSearch
        • operator==()
        • flavor
        • ecm_max
        • max_particles
        • cuts
      • hadros::GeneratedTarget
        • operator==()
        • target
        • supports
      • hadros::Hadron
        • Hadron()
        • Hadron()
        • name()
        • mass()
        • mass_error()
        • spin_parity()
        • flavor()
        • has_explicit_conjugate_name()
        • conjugate_name()
        • is_self_conjugate()
        • is_conjugate_of()
        • is_boson()
        • is_fermion()
        • label()
        • operator==()
        • operator<=>()
      • hadros::HadronCatalog
        • HadronCatalog()
        • HadronCatalog()
        • insert()
        • contains()
        • at()
        • size()
        • empty()
        • metadata()
        • flavor_basis()
        • entries()
        • with_conjugates()
        • validate_conjugates()
      • hadros::HadronCatalogDiff
        • empty()
        • metadata_fields
        • added
        • removed
        • changed
        • missing_conjugates_lhs
        • missing_conjugates_rhs
      • hadros::HadronChange
        • name
        • fields
      • hadros::HadronPrintOptions
        • verbose
        • name_width
        • mass_precision
      • hadros::IndexedChannel
        • index
        • id
        • channel
      • hadros::OneHadronChannel
        • OneHadronChannel()
        • hadron()
        • spin_parity()
        • flavor()
        • threshold()
        • key()
        • label()
        • id()
        • operator<=>()
        • operator==()
      • hadros::OneHadronChannelKey
        • operator<=>()
        • operator==()
        • hadron
      • hadros::PairSpectatorChannel
        • PairSpectatorChannel()
        • pair()
        • spectator()
        • spin_parity()
        • flavor()
        • relative_partial_wave()
        • key()
        • composition_key()
        • threshold()
        • label()
        • id()
        • ordering_key()
        • operator<=>()
        • operator==()
      • hadros::PairSpectatorChannelKey
        • PairSpectatorChannelKey()
        • PairSpectatorChannelKey()
        • operator<=>()
        • operator==()
        • pair
        • spectator
        • relative_partial_wave
        • spin_parity
        • flavor
      • hadros::PairSpectatorGAction
        • is_self_mapping()
        • image
        • phase
      • hadros::PartialWave
        • PartialWave()
        • PartialWave()
        • two_s()
        • two_l()
        • two_j()
        • l()
        • multiplicity()
        • orbital_parity()
        • label()
        • operator<=>()
        • operator==()
      • hadros::PossibleSector
        • operator<=>()
        • operator==()
        • flavor
        • spin_parity
      • hadros::PossibleSectorCuts
        • operator==()
        • l_max
        • pair_l_max
        • relative_l_max
      • hadros::SpinParity
        • SpinParity()
        • SpinParity()
        • two_j()
        • parity()
        • dimension()
        • naturality()
        • has_integer_spin()
        • has_half_integer_spin()
        • label()
        • operator<=>()
        • operator==()
      • hadros::TargetDatabase
        • operator==()
        • flavor_basis
        • metadata
        • targets
      • hadros::TargetQuantumNumbers
        • operator==()
        • two_j
        • parity
        • two_i
        • g_parity
        • baryon_number
        • strangeness
        • charm
        • bottom
      • hadros::TargetSector
        • operator==()
        • two_j
        • parity
        • two_i
        • g_parity
        • baryon_number
        • strangeness
        • charm
        • bottom
        • ecm_max
        • l_max
        • pair_l_max
        • spectator_l_max
      • hadros::TargetSupport
        • operator==()
        • hadrons
        • threshold
      • hadros::ThreeHadronCompositionKey
        • ThreeHadronCompositionKey()
        • ThreeHadronCompositionKey()
        • operator<=>()
        • operator==()
        • hadrons
      • hadros::TwoHadronChannel
        • TwoHadronChannel()
        • first()
        • second()
        • spin_parity()
        • flavor()
        • partial_wave()
        • pair_key()
        • key()
        • threshold()
        • is_identical_pair()
        • two_body_symmetry_factor()
        • label()
        • id()
        • ordering_key()
        • operator<=>()
        • operator==()
      • hadros::TwoHadronChannelKey
        • TwoHadronChannelKey()
        • TwoHadronChannelKey()
        • operator<=>()
        • operator==()
        • pair
        • partial_wave
        • spin_parity
        • flavor
      • hadros::TwoHadronPairKey
        • TwoHadronPairKey()
        • TwoHadronPairKey()
        • operator<=>()
        • operator==()
        • first
        • second
  • 10. License
Hadros
  • Search

© Copyright 2026, Andrew W. Jackura.

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