ethos_penalps.data_classes

Module Contents

Classes

Commodity	This object describes a commodity used in an Enterprise. It can be transported in streams
LoadType	DataClassJsonMixin is an ABC that functions as a Mixin.
ProcessStateData	DataClassJsonMixin is an ABC that functions as a Mixin.
EmptyMetaDataInformation
LoadProfileDataFrameMetaInformation	DataClassJsonMixin is an ABC that functions as a Mixin.
ProductEnergyData	DataClassJsonMixin is an ABC that functions as a Mixin.
StreamLoadEnergyData	DataClassJsonMixin is an ABC that functions as a Mixin.
LoadProfileEntry	DataClassJsonMixin is an ABC that functions as a Mixin.
LoopCounter
ProcessStepProductionPlanEntry	DataClassJsonMixin is an ABC that functions as a Mixin.
StorageProductionPlanEntry	DataClassJsonMixin is an ABC that functions as a Mixin.
StateConnector
ProcessStepDataFrameMetaInformation
StorageDataFrameMetaInformation
CurrentProcessNode
OutputBranchIdentifier
TemporalBranchIdentifier
StreamBranchIdentifier
OutputInputBranchConnector
StaticTimePeriod
ProcessChainIdentifier
ProductionOrder
OrderCollection
ProcessStateEnergyLoadData	DataClassJsonMixin is an ABC that functions as a Mixin.
ProcessStateEnergyLoadDataBasedOnStreamMass	DataClassJsonMixin is an ABC that functions as a Mixin.
ProductionOrderMetadata	DataClassJsonMixin is an ABC that functions as a Mixin.
ProcessStateEnergyData

class ethos_penalps.data_classes.Commodity

Bases: dataclasses_json.DataClassJsonMixin

This object describes a commodity used in an Enterprise. It can be transported in streams or converted into other commodities in process steps.

name: str

__str__() → str

Return str(self).

__repr__() → str

Return repr(self).

class ethos_penalps.data_classes.LoadType

Bases: dataclasses_json.DataClassJsonMixin

DataClassJsonMixin is an ABC that functions as a Mixin.

As with other ABCs, it should not be instantiated directly.

name: str

uuid: str

class ethos_penalps.data_classes.ProcessStateData

Bases: dataclasses_json.DataClassJsonMixin

DataClassJsonMixin is an ABC that functions as a Mixin.

As with other ABCs, it should not be instantiated directly.

process_state_name: str

start_time: datetime.datetime

end_time: datetime.datetime

class ethos_penalps.data_classes.EmptyMetaDataInformation

name: str

object_type: str

class ethos_penalps.data_classes.LoadProfileDataFrameMetaInformation

Bases: dataclasses_json.DataClassJsonMixin

DataClassJsonMixin is an ABC that functions as a Mixin.

As with other ABCs, it should not be instantiated directly.

name: str

object_type: str

data_frame: pandas.DataFrame

first_start_time: datetime.datetime

last_end_time: datetime.datetime

load_type: LoadType

power_unit: str

energy_unit: str

maximum_energy: float

maximum_average_power: float

class ethos_penalps.data_classes.ProductEnergyData

Bases: dataclasses_json.DataClassJsonMixin

DataClassJsonMixin is an ABC that functions as a Mixin.

As with other ABCs, it should not be instantiated directly.

product_commodity: Commodity

specific_energy_demand: float

load_type: LoadType

mass_unit: str

energy_unit: str

class ethos_penalps.data_classes.StreamLoadEnergyData

Bases: dataclasses_json.DataClassJsonMixin

DataClassJsonMixin is an ABC that functions as a Mixin.

As with other ABCs, it should not be instantiated directly.

stream_name: str

specific_energy_demand: float

load_type: LoadType

mass_unit: str

energy_unit: str

class ethos_penalps.data_classes.LoadProfileEntry

Bases: dataclasses_json.DataClassJsonMixin

DataClassJsonMixin is an ABC that functions as a Mixin.

As with other ABCs, it should not be instantiated directly.

load_type: LoadType

start_time: datetime.datetime

end_time: datetime.datetime

energy_quantity: float

energy_unit: str

average_power_consumption: float

power_unit: str

class ethos_penalps.data_classes.LoopCounter

loop_number: float | str = 'Loop has not started'

class ethos_penalps.data_classes.ProcessStepProductionPlanEntry

Bases: dataclasses_json.DataClassJsonMixin

DataClassJsonMixin is an ABC that functions as a Mixin.

As with other ABCs, it should not be instantiated directly.

process_step_name: str

process_state_name: str

start_time: datetime.datetime

end_time: datetime.datetime

duration: str

process_state_type: str

class ethos_penalps.data_classes.StorageProductionPlanEntry

Bases: dataclasses_json.DataClassJsonMixin

DataClassJsonMixin is an ABC that functions as a Mixin.

As with other ABCs, it should not be instantiated directly.

process_step_name: str

start_time: datetime.datetime

end_time: datetime.datetime

duration: str

storage_level_at_start: float

storage_level_at_end: float

commodity: Commodity

class ethos_penalps.data_classes.StateConnector

start_state_name: str

end_state_name: str

class ethos_penalps.data_classes.ProcessStepDataFrameMetaInformation

data_frame: pandas.DataFrame

process_step_name: str

list_of_process_state_names: list[str]

first_start_time: datetime.datetime

last_end_time: datetime.datetime

class ethos_penalps.data_classes.StorageDataFrameMetaInformation

data_frame: pandas.DataFrame

process_step_name: str

commodity: Commodity

first_start_time: datetime.datetime

last_end_time: datetime.datetime

mass_unit: str

class ethos_penalps.data_classes.CurrentProcessNode

node_name: str = 'Node not set yet'

class ethos_penalps.data_classes.OutputBranchIdentifier

branch_number: float

global_unique_identifier: str | None

class ethos_penalps.data_classes.TemporalBranchIdentifier

branch_number: float

global_unique_identifier: str | None

class ethos_penalps.data_classes.StreamBranchIdentifier

stream_name: str

global_unique_identifier: str | None

class ethos_penalps.data_classes.OutputInputBranchConnector

input_branch_identifier: TemporalBranchIdentifier

output_branch_identifier: OutputBranchIdentifier

class ethos_penalps.data_classes.StaticTimePeriod

start_time: datetime.datetime

end_time: datetime.datetime

uuid: OutputBranchIdentifier

get_duration() → datetime.timedelta

class ethos_penalps.data_classes.ProcessChainIdentifier

chain_number: int

chain_name: str

unique_identifier: str

class ethos_penalps.data_classes.ProductionOrder

production_target: float

production_deadline: datetime.datetime

order_number: float

commodity: Commodity

global_unique_identifier: str

produced_mass: float = 0

class ethos_penalps.data_classes.OrderCollection(target_mass: float, commodity: Commodity, order_data_frame: pandas.DataFrame | None = None)

sort_orders_by_deadline(ascending: bool = True)

append_order_collection(order_collection: OrderCollection)

class ethos_penalps.data_classes.ProcessStateEnergyLoadData

Bases: dataclasses_json.DataClassJsonMixin

DataClassJsonMixin is an ABC that functions as a Mixin.

As with other ABCs, it should not be instantiated directly.

process_state_name: str

process_step_name: str

specific_energy_demand: float

load_type: LoadType

mass_unit: str

energy_unit: str

class ethos_penalps.data_classes.ProcessStateEnergyLoadDataBasedOnStreamMass

Bases: ProcessStateEnergyLoadData

DataClassJsonMixin is an ABC that functions as a Mixin.

As with other ABCs, it should not be instantiated directly.

stream_name: str

class ethos_penalps.data_classes.ProductionOrderMetadata

Bases: dataclasses_json.DataClassJsonMixin

DataClassJsonMixin is an ABC that functions as a Mixin.

As with other ABCs, it should not be instantiated directly.

data_frame: pandas.DataFrame

list_of_aggregated_production_order: list[list[numbers.Number]]

list_of_unique_deadlines: list[datetime.datetime]

commodity: Commodity

total_order_mass: numbers.Number

earliest_deadline: datetime.datetime

latest_deadline: datetime.datetime

class ethos_penalps.data_classes.ProcessStateEnergyData

process_step_name: str

process_state_name: str

dict_of_loads: dict[str, LoadType]

dict_of_load_energy_data: dict[str, ProcessStateEnergyLoadData]

add_process_state_energy_load_data(process_state_energy_load_data: ProcessStateEnergyLoadData)

get_dict_of_loads() → dict[str, LoadType]