quacs-parameterization

This repository collects the target parameterizations for the QUACS project. QUACS adds a scripting capability for chemistry and aerosol parameterizations to MUSICA and MPAS-A. The parameterizations here guide the design of that capability.

Each parameterization has a README that tells its inputs, its outputs, and where each one comes from or goes to. Most parameterizations also run in a MUSICA box model.

Layout

Each parameterization is a scheme folder inside a process folder: quacs/<process>/<scheme>/. See CONTRIBUTING.md for the full layout and the steps to add a scheme.

quacs/
└── <process>/
    ├── README.md          # table of the schemes in this process
    └── <scheme>/
        ├── README.md      # status, inputs, outputs, references
        ├── <scheme>.py    # the physics
        ├── examples/      # MUSICA box model scripts and notebooks
        └── tests/

Target parameterizations

Status is one of: implemented, in progress, or placeholder. A placeholder folder has only a README with the content of the target list.

Target class	Process folder	Scheme	Status
Dust emission	dust	GOCART (Ginoux et al., 2001)	implemented (PR #5)
Dust emission	dust	LS99-FENGSHA	placeholder
Dust emission	dust	Kok et al. (2014)	implemented (planned PR)
Dust emission	dust	DEAD (Zender et al., 2003)	implemented (planned PR)
Dust emission	dust	Leung et al. (2023)	implemented (planned PR)
Dry deposition	drydep	Wesely (1989), from CAM	implemented (planned PR)
Dry deposition	drydep	GEOS-Chem, simple	implemented
Dry deposition	drydep	GEOS-Chem, LHS	implemented
Aerosol wet deposition	wetdep	CAM wetdepa_v2	implemented (planned PR)
Aerosol wet deposition	wetdep	PNNL MOSAIC	placeholder
Trace gas wet deposition	wetdep	Neu et al. (2012)	placeholder
MEGAN biogenic emissions	biogenic	MEGAN 3.0	implemented (PR #10)
pyroCb-aware plume rise	plumerise	Freitas et al. (2010) with pyroCb trigger	in progress (PR #11)
VOC and NOx tagged tracers	tagged_tracers	Lapaşcu & Butler (2019)	in progress (planned PR)
Lightning flash rate, parameterized convection	lightning	Price & Rind (1992)	placeholder
Lightning flash rate, resolved convection	lightning	Cummings et al. (2024)	placeholder
Lightning NOx, parameterized convection	lightning	Ott et al. (2010)	placeholder
Lightning NOx, resolved convection	lightning	DeCaria et al. (2000)	placeholder
Aerosol activation	aerosol_activation	GOCART-2G to Thompson	placeholder
New particle formation	nucleation	not selected	placeholder
Aerosol optics	aerosol_optics	Ghan & Zaveri (2007)	placeholder
Aerosol and snow albedo	snow_albedo	SNICAR-ADv3	placeholder
Heterogeneous chemistry	heterogeneous_chem	Uptake on dust	placeholder
Halogenated VSLS	vsls	CESM2-SLH sea-salt bromine	in progress (planned PR)

Installation

pip install -e ".[dev]"

Running tests

pytest

This command runs the unit tests, each example script, each notebook, and the README checks.

Style

ruff formats and lints the code:

ruff check .
ruff format .