Usage with the MUSES Calculation Engine

Module name

module: lepton_module

Labels

Input

Label

Description

Path (inside container)

config

Configuration of the module runtime options

/opt/input/config.yaml

input_eos

Nuclear table input file gridded in temperature and chemical potentials

/opt/input/nuclear_grid.csv

input_particle_properties

Grid data with particle properties information

/opt/input/particle_properties.csv

input_flavor_equilibration

Grid data with flavor equilibration information

/opt/input/flavor_equilibration.csv

Output

Label

Description

Path (inside container)

status

Module execution status

/opt/output/status.yaml

output_config

Configuration of the module runtime options, echoed back

/opt/output/config.yaml

eos_beta_equilibrium

Beta-equilibrium equation of state

/opt/output/beta_equilibrium_eos.csv

eos_charge_neutrality

Charge-neutral equation of state

/opt/output/charge_neutrality_eos.csv

particle_properties_beta_equilibrium

Particle properties for the beta-equilibrium EoS

/opt/output/beta_equilibrium_particle_properties.csv

particle_properties_charge_neutrality

Particle properties for the charge-neutral EoS

/opt/output/charge_neutrality_particle_properties.csv

flavor_equilibration

Charge-neutral EoS with the variables required by the flavor equilibration module

/opt/output/charge_neutrality_flavor_equilibration.csv

lepton_eos

Purely leptonic EoS

/opt/output/lepton_eos.csv

lepton_particle_properties

Particle properties for the purely leptonic EoS

/opt/output/lepton_particle_properties.csv

Workflow example

The snippet below shows a typical CE workflow that pipes the output of a eos_module into the lepton_module to compute the beta-equilibrium EoS:

processes:
- name: <<eos_process_name>>
  module: <<ce_eos_module>>
  config:
  {}
- name: lepton_process
  module: lepton_module
  config:
    global:
      use_beta_equilibrium: true
    particles:
      use_electron: true
      use_muon: true
  pipes:
    input_eos:
      label: eos_file
      module: <<ce_eos_module>>
      process: <<eos_process_name>>
components:
- type: chain
  name: workflow
  sequence:
  - <<eos_process_name>>
  - lepton_process

The input_eos pipe maps the upstream eos_file output label of <<ce_eos_module>> to the input_eos input label of this module.

Troubleshooting

The module exits with a non-zero status code.

Inspect /opt/output/status.yaml for the detailed message. Status codes follow an HTTP-style convention:

  • 200 — success.

  • 300/301 — invalid or failed physics (e.g. EoS failed the stability or causality check, see check_eos_stability/check_eos_causality).

  • 400/404/422 — invalid, missing, or unparsable input configuration.

  • 500/501/503 — internal error, unimplemented feature, or permission error.

Beta-equilibrium fails with “EoS is not stable” or “EoS is not causal”.

Enable them explicitly via check_eos_stability/check_eos_causality to catch nuclear models that are unstable or superluminal before they reach downstream modules. Both are disabled by default.

Verbose / debug output.

Increase global.verbose in the config:

  • 0 — silent (default)

  • 1 — standard progress

  • 2/3 — detailed solver and derivative diagnostics

Validating a config file locally.

python3 scripts/validate_config.py --config_file_path input/

For questions, issues or bug reports, open an issue on the GitLab repository of the module, post on the MUSES Forum, or contact the lead developer: