API Reference
Technical reference for AeroViz. The Guide is the place to learn the workflow; these pages document signatures, inputs and outputs.
Reading data
- RawDataReader — the factory: one instrument name, one folder, a QC'd DataFrame back.
- AbstractReader — the base class every reader extends.
- Quality Control — the statistical filters and the
QCRule/QCFlagBuildermachinery. - Supported Instruments — the catalogue, and one page per instrument with its raw format, status codes, QC rules and outputs.
| Family | Instruments |
|---|---|
| Aethalometers / BC | AE33, AE43, BC1054, MA350 |
| Nephelometers | Aurora, NEPH |
| Particle sizers | SMPS, APS, GRIMM |
| Mass | TEOM, BAM1020 |
| Chemistry | IGAC, OCEC, Xact |
| External | EPA |
| Not readable | VOC (pre-aggregated; read with pandas, then voc_potentials), Minion (removed), Q-ACSM (reader pending) |
Post-processing
- Overview and migration from
DataProcess AeroViz.size— size-distribution statistics, SMPS–APS merge,SizeDistAeroViz.chemistry— mass reconstruction, refractive index, kappa, partitioning, OC/EC, ISORROPIAAeroViz.optical— IMPROVE, Mie, gas extinction, RI retrieval, brown carbonAeroViz.voc— OFP / SOAP / LOH- Utilities —
DataBase,DataClassifier
Plotting
Plot — basic charts, time series,
size distribution, meteorology,
optical, templates. Needs the plot extra.
Conventions
Docstrings follow the NumPy style and are rendered by mkdocstrings: parameters with types, return values, and examples where a call is not obvious. Where a page states a threshold, a status code or a rule list, it is checked against the reader source — several tables are parsed back out by the test suite.