State

class zdm.parameters.State[source]

Bases: myData

Central configuration object containing all model parameters.

The State class aggregates all parameter dataclasses into a single object that is passed to Grid, Survey, and other components. It provides dictionary-like access to parameter groups and methods for updating parameters.

analysis

Analysis-level settings.

Type:

AnalysisParams

cosmo

Cosmological parameters.

Type:

CosmoParams

FRBdemo

FRB population parameters.

Type:

FRBDemoParams

rep

Repeater parameters.

Type:

RepeatParams

MW

Milky Way parameters.

Type:

MWParams

host

Host galaxy parameters.

Type:

HostParams

IGM

IGM parameters.

Type:

IGMParams

width

Width distribution parameters.

Type:

WidthParams

scat

Scattering parameters.

Type:

ScatParams

energy

Energy function parameters.

Type:

EnergeticsParams

Example

>>> state = State()
>>> state.cosmo.H0
67.66
>>> state['cosmo'].H0  # Dictionary-style access
67.66
>>> state.update_param('gamma', -1.5)

Methods Summary

set_astropy_cosmo(cosmo)

Import cosmological parameters from an astropy Cosmology object.

set_dataclasses()

Initialize all parameter dataclass instances with defaults.

update_param(param, value)

Update a single parameter by name.

Methods Documentation

set_astropy_cosmo(cosmo)[source]

Import cosmological parameters from an astropy Cosmology object.

Parameters:

cosmo (astropy.cosmology.Cosmology) – Astropy cosmology object (e.g., Planck18, WMAP9).

set_dataclasses()[source]

Initialize all parameter dataclass instances with defaults.

update_param(param: str, value)[source]

Update a single parameter by name.

Automatically finds which dataclass contains the parameter and updates it. Handles special cases like H0 updating Omega_b.

Parameters:
  • param (str) – Parameter name (e.g., ‘H0’, ‘gamma’, ‘lEmax’).

  • value (any) – New value for the parameter.

__init__()[source]
set_dataclasses()[source]

Initialize all parameter dataclass instances with defaults.

update_param(param: str, value)[source]

Update a single parameter by name.

Automatically finds which dataclass contains the parameter and updates it. Handles special cases like H0 updating Omega_b.

Parameters:
  • param (str) – Parameter name (e.g., ‘H0’, ‘gamma’, ‘lEmax’).

  • value (any) – New value for the parameter.

set_astropy_cosmo(cosmo)[source]

Import cosmological parameters from an astropy Cosmology object.

Parameters:

cosmo (astropy.cosmology.Cosmology) – Astropy cosmology object (e.g., Planck18, WMAP9).