RunFeemsSim 0.4.4__tar.gz → 0.6.0__tar.gz

{runfeemssim-0.4.4 → runfeemssim-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RunFeemsSim
-Version: 0.4.4
+Version: 0.6.0
 Summary: A library for running feems simulation
 Author-email: Kevin Koosup Yum <kevinkoosup.yum@gmail.com>
 License-Expression: Apache-2.0

{runfeemssim-0.4.4 → runfeemssim-0.6.0}/RunFeemsSim/machinery_calculation.py

@@ -298,6 +298,7 @@ class MachineryCalculation:
         fuel_specified_by: FuelSpecifiedBy = FuelSpecifiedBy.IMO,
         ignore_power_balance: bool = False,
         fuel_option: Optional[FuelOption] = None,
+        steam_demand_kg_per_h: Optional[np.ndarray] = None,
     ) -> Union[FEEMSResult, FEEMSResultForMachinerySystem]:
         """
         Calculate the machinery system output from a time series of the propulsion power and
@@ -313,6 +314,8 @@ class MachineryCalculation:
             ignore_power_balance(bool): If True, the power balance calculation will be ignored.
             fuel_option(FuelOption): The fuel option to be used in the simulation. If None, the
                 default fuel option in the system will be used.
+            steam_demand_kg_per_h: Steam demand time series (kg/h). Must have the same length as
+                propulsion_power. If None and a boiler is attached, demand is treated as zero.
 
         Returns:
             The result of the calculation. FEEMSResult or FEEMSResultForMachinerySystem.
@@ -347,11 +350,23 @@ class MachineryCalculation:
                 f"The length of the auxiliary power({len(auxiliary_power_kw)}) must be 1"
                 f" or the same as the propulsion power ({len(propulsion_power)})"
             )
+        n_steps = len(propulsion_power)
+        if steam_demand_kg_per_h is not None:
+            if len(steam_demand_kg_per_h) != n_steps:
+                raise ValueError(
+                    f"The length of steam_demand_kg_per_h ({len(steam_demand_kg_per_h)}) must match "
+                    f"propulsion_power ({n_steps})."
+                )
 
         self._set_input_load_time_interval_from_propulsion_power_time_series(
             propulsion_power_time_series=propulsion_power,
             auxiliary_load_kw=auxiliary_power_kw,
         )
+        if self.system_feems.boiler is not None:
+            self.system_feems.boiler.steam_out_kg_per_h = (
+                steam_demand_kg_per_h if steam_demand_kg_per_h is not None
+                else np.zeros(n_steps)
+            )
         return self._run_simulation(
             fuel_specified_by=fuel_specified_by,
             ignore_power_balance=ignore_power_balance,
@@ -368,6 +383,7 @@ class MachineryCalculation:
         fuel_specified_by: FuelSpecifiedBy = FuelSpecifiedBy.IMO,
         ignore_power_balance: bool = False,
         fuel_option: Optional[FuelOption] = None,
+        steam_demand_kg_per_h: Optional[np.ndarray] = None,
     ) -> Union[FEEMSResult, FEEMSResultForMachinerySystem]:
         """
         Calculate the machinery system output from statistics of the propulsion power.
@@ -377,6 +393,8 @@ class MachineryCalculation:
             ignore_power_balance(bool): If True, the power balance calculation will be ignored.
             fuel_option(FuelOption): The fuel option to be used in the simulation. If None, the
                 default fuel option in the system will be used.
+            steam_demand_kg_per_h: Steam demand time series (kg/h). Must have the same length as
+                the time series. If None and a boiler is attached, demand is treated as zero.
 
         Returns:
             The result of the simulation. FEEMSResult or FEEMSResultForMachinery system.
@@ -398,7 +416,18 @@ class MachineryCalculation:
             raise TypeError(
                 "time_series must be a TimeSeriesResult or TimeSeriesResultForMultiplePropulsors."
             )
-
+        n_steps = len(df)
+        if steam_demand_kg_per_h is not None:
+            if len(steam_demand_kg_per_h) != n_steps:
+                raise ValueError(
+                    f"The length of steam_demand_kg_per_h ({len(steam_demand_kg_per_h)}) must match "
+                    f"the time series ({n_steps})."
+                )
+        if self.system_feems.boiler is not None:
+            self.system_feems.boiler.steam_out_kg_per_h = (
+                steam_demand_kg_per_h if steam_demand_kg_per_h is not None
+                else np.zeros(n_steps)
+            )
         return self._run_simulation(
             fuel_specified_by=fuel_specified_by,
             ignore_power_balance=ignore_power_balance,
@@ -414,6 +443,7 @@ class MachineryCalculation:
         fuel_specified_by: FuelSpecifiedBy = FuelSpecifiedBy.IMO,
         ignore_power_balance: bool = False,
         fuel_option: Optional[FuelOption] = None,
+        steam_demand_kg_per_h: Optional[np.ndarray] = None,
     ) -> Union[FEEMSResult, FEEMSResultForMachinerySystem]:
         """
         Calculate the machinery system output from statistics of the propulsion power.
@@ -428,19 +458,33 @@ class MachineryCalculation:
             ignore_power_balance(bool): If True, the power balance calculation will be ignored.
             fuel_option(FuelOption): The fuel option to be used in the simulation. If None, the
                 default fuel option in the system will be used.
+            steam_demand_kg_per_h: Steam demand for each mode in kg/h. Must have the same length
+                as propulsion_power. If None and a boiler is attached, demand is treated as zero.
 
         Returns:
             The result of the simulation. FEEMSResult or FEEMSResultForMachinery system.
         """
+        n_steps = len(propulsion_power)
         if not np.isscalar(auxiliary_power_kw):
             assert (
-                len(propulsion_power) == len(auxiliary_power_kw) or len(auxiliary_power_kw) == 1
+                n_steps == len(auxiliary_power_kw) or len(auxiliary_power_kw) == 1
             ), "The length of the auxiliary power must be 1 or the same as the propulsion power"
+        if steam_demand_kg_per_h is not None:
+            if len(steam_demand_kg_per_h) != n_steps:
+                raise ValueError(
+                    f"The length of steam_demand_kg_per_h ({len(steam_demand_kg_per_h)}) must match "
+                    f"propulsion_power ({n_steps})."
+                )
         self._set_input_load_time_interval_from_propulsion_power_time_series(
             propulsion_power_time_series=pd.Series(data=propulsion_power, index=frequency),
             auxiliary_load_kw=auxiliary_power_kw,
             time_is_given_as_interval=True,
         )
+        if self.system_feems.boiler is not None:
+            self.system_feems.boiler.steam_out_kg_per_h = (
+                steam_demand_kg_per_h if steam_demand_kg_per_h is not None
+                else np.zeros(n_steps)
+            )
         return self._run_simulation(
             fuel_specified_by=fuel_specified_by,
             ignore_power_balance=ignore_power_balance,

{runfeemssim-0.4.4 → runfeemssim-0.6.0}/RunFeemsSim.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RunFeemsSim
-Version: 0.4.4
+Version: 0.6.0
 Summary: A library for running feems simulation
 Author-email: Kevin Koosup Yum <kevinkoosup.yum@gmail.com>
 License-Expression: Apache-2.0

{runfeemssim-0.4.4 → runfeemssim-0.6.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "RunFeemsSim"
-version = "0.4.4"
+version = "0.6.0"
 description = "A library for running feems simulation"
 readme = "README.md"
 requires-python = ">=3.10"

{runfeemssim-0.4.4 → runfeemssim-0.6.0}/tests/test_machinery_calculation.py

@@ -3,14 +3,20 @@ import random
 
 import numpy as np
 import pandas as pd
-from feems.components_model.component_electric import Genset
+from feems.components_model.component_electric import (
+    COGES,
+    ElectricComponent,
+    ElectricMachine,
+    Genset,
+)
 from feems.components_model.component_mechanical import (
+    COGAS,
     EngineMultiFuel,
     FuelCharacteristics,
 )
 from feems.fuel import FuelOrigin, FuelSpecifiedBy, TypeFuel
-from feems.system_model import FuelOption
-from feems.types_for_feems import EngineCycleType, TypeComponent
+from feems.system_model import ElectricPowerSystem, FuelOption
+from feems.types_for_feems import EngineCycleType, TypeComponent, TypePower
 from MachSysS.convert_to_feems import convert_proto_propulsion_system_to_feems
 from MachSysS.gymir_result_pb2 import (
     GymirResult,
@@ -343,3 +349,115 @@ def test_machinery_calculation_multifuel():
         < 1e-2
     )
 
+
+def _build_coges_electric_system(eff_curve: np.ndarray) -> ElectricPowerSystem:
+    """Build a minimal ElectricPowerSystem with a multi-fuel COGES (LNG + H2) and an other_load."""
+    generator = ElectricMachine(
+        type_=TypeComponent.GENERATOR,
+        name="COGES Gen",
+        rated_power=1000,
+        rated_speed=3000,
+        power_type=TypePower.POWER_SOURCE,
+        switchboard_id=1,
+    )
+    cogas = COGAS(
+        name="COGAS",
+        rated_power=1000,
+        rated_speed=3000,
+        eff_curve=eff_curve,
+        fuel_type=TypeFuel.NATURAL_GAS,
+        fuel_origin=FuelOrigin.FOSSIL,
+        multi_fuel_characteristics=[
+            FuelCharacteristics(
+                main_fuel_type=TypeFuel.NATURAL_GAS,
+                main_fuel_origin=FuelOrigin.FOSSIL,
+                eff_curve=eff_curve,
+                engine_cycle_type=EngineCycleType.BRAYTON,
+            ),
+            FuelCharacteristics(
+                main_fuel_type=TypeFuel.HYDROGEN,
+                main_fuel_origin=FuelOrigin.RENEWABLE_NON_BIO,
+                eff_curve=eff_curve,
+                engine_cycle_type=EngineCycleType.BRAYTON,
+            ),
+        ],
+    )
+    coges_component = COGES(name="COGES unit", cogas=cogas, generator=generator)
+
+    other_load = ElectricComponent(
+        type_=TypeComponent.OTHER_LOAD,
+        name="Aux load",
+        rated_power=500,
+        power_type=TypePower.POWER_CONSUMER,
+        switchboard_id=1,
+        eff_curve=np.array([[0.0, 1.0], [1.0, 1.0]]),
+    )
+    return ElectricPowerSystem(
+        name="COGES test system",
+        power_plant_components=[coges_component, other_load],
+        bus_tie_connections=[],
+    )
+
+
+def test_machinery_calculation_multifuel_coges():
+    eff_curve = np.array([[0.0, 0.30], [0.5, 0.40], [1.0, 0.44]])
+    system = _build_coges_electric_system(eff_curve)
+
+    machinery_calculation = MachineryCalculation(feems_system=system)
+
+    run_kwargs = dict(
+        propulsion_power=np.array([0.0]),
+        frequency=np.array([3600.0]),
+        auxiliary_power_kw=500.0,
+        fuel_specified_by=FuelSpecifiedBy.IMO,
+    )
+
+    # Default (no fuel_option) → first mode = LNG
+    res_default = machinery_calculation.calculate_machinery_system_output_from_statistics(
+        **run_kwargs
+    )
+
+    # Force H2
+    res_h2 = machinery_calculation.calculate_machinery_system_output_from_statistics(
+        **run_kwargs,
+        fuel_option=FuelOption(
+            fuel_type=TypeFuel.HYDROGEN,
+            fuel_origin=FuelOrigin.RENEWABLE_NON_BIO,
+            for_pilot=False,
+            primary=False,
+        ),
+    )
+
+    # Force LNG explicitly
+    res_lng = machinery_calculation.calculate_machinery_system_output_from_statistics(
+        **run_kwargs,
+        fuel_option=FuelOption(
+            fuel_type=TypeFuel.NATURAL_GAS,
+            fuel_origin=FuelOrigin.FOSSIL,
+            for_pilot=False,
+            primary=True,
+        ),
+    )
+
+    fuels_default = res_default.multi_fuel_consumption_total_kg.fuels
+    fuels_h2 = res_h2.multi_fuel_consumption_total_kg.fuels
+
+    # Default = LNG: natural_gas consumed, no hydrogen
+    assert any(f.fuel_type == TypeFuel.NATURAL_GAS and f.mass_or_mass_fraction > 0
+               for f in fuels_default), "Default mode should consume natural gas"
+    assert not any(f.fuel_type == TypeFuel.HYDROGEN and f.mass_or_mass_fraction > 0
+                   for f in fuels_default), "Default mode should not consume hydrogen"
+
+    # H2 forced: hydrogen consumed, no natural_gas
+    assert any(f.fuel_type == TypeFuel.HYDROGEN and f.mass_or_mass_fraction > 0
+               for f in fuels_h2), "H2 mode should consume hydrogen"
+    assert not any(f.fuel_type == TypeFuel.NATURAL_GAS and f.mass_or_mass_fraction > 0
+                   for f in fuels_h2), "H2 mode should not consume natural gas"
+
+    # LNG forced matches default
+    assert np.isclose(
+        res_default.fuel_consumption_total_kg,
+        res_lng.fuel_consumption_total_kg,
+        rtol=1e-6,
+    ), "Explicit LNG option should match default"
+