Python API¶
Simulate HAWC ALI observations and retrievals from CESM2/WACCM output.
The package has two tiers. The base install extracts WACCM columns and
saves simulator-ready inputs (cesm_hawc.waccm,
cesm_hawc.save_inputs). The [sim] extra adds the ALI forward
model and L2 retrieval (cesm_hawc.simulation,
cesm_hawc.constituents). Call configure_environment() once
before using the [sim] tier from your own code.
| Module | Description |
|---|---|
cesm_hawc.calibration | Workarounds for cache races when many simulations run in parallel. |
cesm_hawc.cli | The cesm-hawc command-line interface. |
cesm_hawc.config | Read and validate the config.toml file used by the CLI. |
cesm_hawc.constituents | Build the sasktran2 constituents that represent a WACCM column. |
cesm_hawc.convergence | Convergence diagnostics for the L2 retrieval. |
cesm_hawc.dispatch | Run independent jobs serially or across a pool of worker processes. |
cesm_hawc.env | Process-wide setup needed by the simulation ([sim]) code paths. |
cesm_hawc.file_index | Find CAM history files and read the dates in their names. |
cesm_hawc.noise | The ALI instrument noise model used throughout cesm-hawc. |
cesm_hawc.orbit_files | Read observation geometry from HAWC orbit files. |
cesm_hawc.outputs | Text summaries written by the cesm-hawc run command. |
cesm_hawc.resume | Helpers that let long batch runs resume after being interrupted. |
cesm_hawc.save_inputs | Save WACCM columns as simulator-ready NetCDF files. |
cesm_hawc.simulation | Run the HAWC ALI simulator on WACCM columns. |
cesm_hawc.waccm | Read CESM2/WACCM history files and extract atmospheric columns. |