# API reference

The complete curated top-level public API, generated from `aquakin.__all__`. Each domain also exposes its full surface as a subpackage (`aquakin.plant`, `aquakin.integrate`, `aquakin.utils`).

## Classes

```{eval-rst}
.. autosummary::
   :toctree: generated
   :nosignatures:

   aquakin.ActivatedSludgeSizing
   aquakin.Aeration
   aquakin.AerationDesignPoint
   aquakin.AerationSystem
   aquakin.AlgebraicTemperature
   aquakin.BSM1Evaluation
   aquakin.BSM2Evaluation
   aquakin.BatchReactor
   aquakin.BatchSolution
   aquakin.BiofilmReactor
   aquakin.BiofilmSolution
   aquakin.CFDReactor
   aquakin.CSTRUnit
   aquakin.CalibrationResult
   aquakin.CarbonFootprint
   aquakin.ChlorineContactUnit
   aquakin.CompiledModel
   aquakin.ComponentBalance
   aquakin.Constraint
   aquakin.CostFactors
   aquakin.DGSMResult
   aquakin.DifferentiationConfig
   aquakin.Event
   aquakin.EventedResult
   aquakin.FitResult
   aquakin.ForwardSensitivityResult
   aquakin.FreeICConfig
   aquakin.HeatBalanceTemperature
   aquakin.IdentityTranslator
   aquakin.InfluentFractions
   aquakin.InfluentSeries
   aquakin.IntegratorConfig
   aquakin.KPIComparison
   aquakin.LaplaceConfig
   aquakin.MassBalance
   aquakin.MixerUnit
   aquakin.MonteCarloResult
   aquakin.NoDigesterError
   aquakin.OperatingConditions
   aquakin.OperatingCost
   aquakin.OptimizeResult
   aquakin.OptimizerConfig
   aquakin.PFRSolution
   aquakin.ParticleTrackReactor
   aquakin.Plant
   aquakin.PlantCheck
   aquakin.PlantSolution
   aquakin.PlugFlowReactor
   aquakin.PredictiveBand
   aquakin.ProfileResult
   aquakin.RatioSplitter
   aquakin.ScenarioComparison
   aquakin.SensitivityResult
   aquakin.SetpointSplitter
   aquakin.SludgeMetrics
   aquakin.SpatialConditions
   aquakin.SpeciationUnitsWarning
   aquakin.StateTranslator
   aquakin.Stream
   aquakin.TemperatureModel
   aquakin.ThresholdSplitter
   aquakin.Track
   aquakin.TrackSolution
   aquakin.UVUnit
   aquakin.Unit
   aquakin.UnitWarning
   aquakin.UnknownPortError
   aquakin.UnknownUnitError
   aquakin.WiringError
```

## Functions

```{eval-rst}
.. autosummary::
   :toctree: generated
   :nosignatures:

   aquakin.aeration_energy
   aquakin.blower_airflow_total
   aquakin.blower_energy
   aquakin.blower_power_kw
   aquakin.calibrate
   aquakin.canonical_content
   aquakin.carbon_footprint
   aquakin.carbon_mass
   aquakin.characterize_influent
   aquakin.check_conservation
   aquakin.check_finite_gradient
   aquakin.check_model_units
   aquakin.check_nitrogen
   aquakin.clear_model_cache
   aquakin.co2e_from_energy
   aquakin.compare_scenarios
   aquakin.compile_model
   aquakin.composition_table
   aquakin.ct_log_removal
   aquakin.ct_value
   aquakin.derived_BOD
   aquakin.derived_COD
   aquakin.derived_TKN
   aquakin.derived_TSS
   aquakin.design_summary
   aquakin.dgsm
   aquakin.direct_n2o_emission
   aquakin.effluent_averages
   aquakin.effluent_quality_index
   aquakin.esdirk_adjoint_solve
   aquakin.evaluate_bsm1
   aquakin.evaluate_bsm2
   aquakin.fit
   aquakin.forward_adjoint
   aquakin.forward_sensitivity
   aquakin.fractionate
   aquakin.heating_energy
   aquakin.implicit_euler_adjoint_solve
   aquakin.integrate_ensemble
   aquakin.kpi_comparison
   aquakin.load_model
   aquakin.load_model_from_file
   aquakin.mass_balance
   aquakin.methane_to_co2e
   aquakin.mixing_energy
   aquakin.monte_carlo
   aquakin.n2o_n_to_co2e
   aquakin.operating_cost
   aquakin.operational_cost_index
   aquakin.operational_cost_index_bsm2
   aquakin.optimize_design
   aquakin.parse_rate_expression
   aquakin.parse_units
   aquakin.profile_likelihood
   aquakin.pumping_energy
   aquakin.pumping_energy_bsm2
   aquakin.read_influent_csv
   aquakin.required_airflow
   aquakin.sensitivity
   aquakin.size_activated_sludge
   aquakin.sludge_metrics
   aquakin.solve_with_events
   aquakin.stripped_n2o
   aquakin.t10_from_baffling
   aquakin.t10_from_rtd
   aquakin.time_average
   aquakin.uv_dose
   aquakin.uv_log_inactivation
```