aquakin.BSM2Evaluation#

class aquakin.BSM2Evaluation(eqi, oci, aeration_energy, pumping_energy, mixing_energy, sludge_production, carbon_mass, methane_production, heating_energy, effluent=<factory>, aerated_tanks=<factory>, air_flow=None, oci_note='Full BSM2 OCI (Gernaey et al. 2014): AE + PE + ME + 3*sludge + 3*carbon - 6*methane + max(0, HE - 7*methane). Sludge production is the disposal TSS mass flow (plant TSS-inventory change neglected -- ~0 at steady state); the heating feed temperature defaults to 15 C unless supplied.')[source]#

Bases: object

Headline BSM2 performance indices from a solved plant.

str(eval) / report() give a labeled, units-annotated breakdown of the EQI, the OCI and every component term (with its OCI contribution) 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) – Full BSM2 Operational Cost Index (Gernaey et al. 2014): AE + PE + ME + 3·sludge + 3·carbon − 6·methane + max(0, HE − 7·methane).

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

  • pumping_energy (float) – Pumping energy PE (kWh/d), over the full BSM2 pump set (AS internal recycle, RAS, wastage, and the primary / thickener / dewatering underflows).

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

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

  • carbon_mass (float) – External-carbon dose (kg COD/d), time-averaged.

  • methane_production (float) – Digester methane production (kg CH₄/d) – the OCI’s biogas credit.

  • heating_energy (float) – Digester sludge-heating energy HE (kWh/d).

  • 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)

  • mixing_energy (float)

  • sludge_production (float)

  • carbon_mass (float)

  • methane_production (float)

  • heating_energy (float)

  • effluent (dict)

  • aerated_tanks (list)

  • air_flow (float | None)

  • oci_note (str)

__init__(eqi, oci, aeration_energy, pumping_energy, mixing_energy, sludge_production, carbon_mass, methane_production, heating_energy, effluent=<factory>, aerated_tanks=<factory>, air_flow=None, oci_note='Full BSM2 OCI (Gernaey et al. 2014): AE + PE + ME + 3*sludge + 3*carbon - 6*methane + max(0, HE - 7*methane). Sludge production is the disposal TSS mass flow (plant TSS-inventory change neglected -- ~0 at steady state); the heating feed temperature defaults to 15 C unless supplied.')#
Parameters:

  • eqi (float)

  • oci (float)

  • aeration_energy (float)

  • pumping_energy (float)

  • mixing_energy (float)

  • sludge_production (float)

  • carbon_mass (float)

  • methane_production (float)

  • heating_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

oci_note

eqi

oci

aeration_energy

pumping_energy

mixing_energy

sludge_production

carbon_mass

methane_production

heating_energy

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 physical value, units, and signed contribution to the index, the effluent averages, and the oci_note caveat – so the headline numbers are not bare floats to misread against published values.

Return type:

str