aquakin.BSM1Evaluation#

class aquakin.BSM1Evaluation(eqi, oci, aeration_energy, pumping_energy, sludge_production, mixing_energy=0.0, effluent=<factory>, aerated_tanks=<factory>, air_flow=None, oci_note='BSM1 OCI (updated benchmark): AE + PE + ME + 5*sludge, where ME is the mechanical-mixing energy of the unaerated reactors (the original Copp 2002 index omits it). Sludge production is the wastage TSS mass flow (plant TSS-inventory change neglected -- ~0 at steady state).')[source]#

Bases: object

Headline BSM1 performance indices from a solved plant.

str(eval) / report() give a labeled, units-annotated breakdown of the EQI, the OCI and every component term plus the oci_note caveat; the raw fields below stay available for programmatic use.

Variables:

  • eqi (float) – Effluent Quality Index (kg pollutant / day), lower is better.

  • oci (float) – BSM1 Operational Cost Index: AE + PE + ME + 5·sludge (the updated benchmark convention, which adds mixing energy to the original Copp 2002 AE + PE + 5·sludge).

  • aeration_energy (float) – Aeration energy AE (kWh/d).

  • pumping_energy (float) – Pumping energy PE (kWh/d): the internal recycle, RAS and wastage pumps.

  • sludge_production (float) – Wasted-sludge TSS mass flow (kg TSS/d), time-averaged.

  • mixing_energy (float) – Mixing energy ME (kWh/d): mechanical mixing of the unaerated reactors.

  • effluent (dict) – Time/flow-weighted average effluent concentrations (COD, BOD, TSS, TKN, SNH, SNO; g/m^3) from effluent_averages().

  • aerated_tanks (list[str]) – The reactors whose aeration was counted.

  • air_flow (float or None) – Total blower air flow (m³/d, time-averaged) when an aeration_system diffuser/blower design was supplied; None for the correlation default.

  • oci_note (str) – Notes on the OCI computation.

Parameters:

  • eqi (float)

  • oci (float)

  • aeration_energy (float)

  • pumping_energy (float)

  • sludge_production (float)

  • mixing_energy (float)

  • effluent (dict)

  • aerated_tanks (list)

  • air_flow (float | None)

  • oci_note (str)

__init__(eqi, oci, aeration_energy, pumping_energy, sludge_production, mixing_energy=0.0, effluent=<factory>, aerated_tanks=<factory>, air_flow=None, oci_note='BSM1 OCI (updated benchmark): AE + PE + ME + 5*sludge, where ME is the mechanical-mixing energy of the unaerated reactors (the original Copp 2002 index omits it). Sludge production is the wastage TSS mass flow (plant TSS-inventory change neglected -- ~0 at steady state).')#
Parameters:

  • eqi (float)

  • oci (float)

  • aeration_energy (float)

  • pumping_energy (float)

  • sludge_production (float)

  • mixing_energy (float)

  • effluent (dict)

  • aerated_tanks (list)

  • air_flow (float | None)

  • oci_note (str)

Return type:

None

Methods

__init__(eqi, oci, aeration_energy, ...[, ...])

kpis()

Headline performance KPIs for a scenario comparison table.

report()

A labeled, units-annotated EQI / OCI breakdown (also str(eval)).

total_energy()

Total electricity draw (kWh/d) = aeration + pumping + mixing -- the energy basis for the GHG and cost layers.

Attributes

air_flow

mixing_energy

oci_note

eqi

oci

aeration_energy

pumping_energy

sludge_production

effluent

aerated_tanks

total_energy()[source]#

Total electricity draw (kWh/d) = aeration + pumping + mixing – the energy basis for the GHG and cost layers.

Return type:

float

kpis()[source]#

Headline performance KPIs for a scenario comparison table.

Return type:

dict

report()[source]#

A labeled, units-annotated EQI / OCI breakdown (also str(eval)).

Shows each OCI term with its value, units and signed contribution to the index, the effluent averages, and the oci_note caveat.

Return type:

str