Inputs and results#

Immutable inputs and interval-integrated outputs with units in field names.

class x2power.models.SolidFeedstock(mass_kg, moisture_fraction, dry_lhv_mj_per_kg)[source]#

Mass over one interval. Moisture is wet-basis; LHV is per kg dry matter.

Parameters:
  • mass_kg (float)

  • moisture_fraction (float)

  • dry_lhv_mj_per_kg (float)

mass_kg: float#
moisture_fraction: float#
dry_lhv_mj_per_kg: float#
property dry_mass_kg: float#
property water_mass_kg: float#
property chemical_energy_kwh: float#
class x2power.models.Generator(electrical_efficiency, heat_recovery_efficiency=0.0, rated_power_kw=None)[source]#

Constant LHV-basis efficiencies; rating is gross electrical power.

Parameters:
  • electrical_efficiency (float)

  • heat_recovery_efficiency (float)

  • rated_power_kw (float | None)

electrical_efficiency: float#
heat_recovery_efficiency: float = 0.0#
rated_power_kw: float | None = None#
class x2power.models.AuxiliaryLoads(fixed_power_kw=0.0, electricity_fraction_of_gross=0.0, process_electricity_kwh=0.0, electric_heater_efficiency=1.0, process_heat_usable_fraction=1.0)[source]#

Standing load applies throughout the interval, including generator outages.

Parameters:
  • fixed_power_kw (float)

  • electricity_fraction_of_gross (float)

  • process_electricity_kwh (float)

  • electric_heater_efficiency (float)

  • process_heat_usable_fraction (float)

fixed_power_kw: float = 0.0#
electricity_fraction_of_gross: float = 0.0#
process_electricity_kwh: float = 0.0#
electric_heater_efficiency: float = 1.0#
process_heat_usable_fraction: float = 1.0#
class x2power.models.PowerResult(duration_h, fuel_energy_available_kwh, fuel_energy_used_kwh, unused_fuel_energy_kwh, gross_electricity_kwh, recovered_heat_kwh, generator_loss_kwh, process_heat_demand_kwh, heat_to_process_kwh, surplus_heat_kwh, electric_heating_kwh, auxiliary_electricity_kwh, net_electricity_kwh, balance_residual_kwh)[source]#

Energy ledger at the generator boundary, plus explicit plant electrical loads.

Parameters:
  • duration_h (float)

  • fuel_energy_available_kwh (float)

  • fuel_energy_used_kwh (float)

  • unused_fuel_energy_kwh (float)

  • gross_electricity_kwh (float)

  • recovered_heat_kwh (float)

  • generator_loss_kwh (float)

  • process_heat_demand_kwh (float)

  • heat_to_process_kwh (float)

  • surplus_heat_kwh (float)

  • electric_heating_kwh (float)

  • auxiliary_electricity_kwh (float)

  • net_electricity_kwh (float)

  • balance_residual_kwh (float)

duration_h: float#
fuel_energy_available_kwh: float#
fuel_energy_used_kwh: float#
unused_fuel_energy_kwh: float#
gross_electricity_kwh: float#
recovered_heat_kwh: float#
generator_loss_kwh: float#
process_heat_demand_kwh: float#
heat_to_process_kwh: float#
surplus_heat_kwh: float#
electric_heating_kwh: float#
auxiliary_electricity_kwh: float#
net_electricity_kwh: float#
balance_residual_kwh: float#
property net_power_kw: float#
property net_electrical_efficiency: float | None#

Net electricity / available fuel energy; undefined for zero fuel.

class x2power.models.SimulationResult(route: str, power: x2power.models.PowerResult, metrics: dict[str, float]=<factory>)[source]#
Parameters:
  • route (str)

  • power (PowerResult)

  • metrics (dict[str, float])

route: str#
power: PowerResult#
metrics: dict[str, float]#
to_dict()[source]#
Return type:

dict[str, Any]