:py:mod:`ethos_penalps.load_profile_calculator` =============================================== .. py:module:: ethos_penalps.load_profile_calculator Module Contents --------------- Classes ~~~~~~~ .. autoapisummary:: ethos_penalps.load_profile_calculator.StreamLoadProfileEntryCollection ethos_penalps.load_profile_calculator.ProcessStepLoadProfileEntryCollection ethos_penalps.load_profile_calculator.LoadProfileMetaDataFrameCollection ethos_penalps.load_profile_calculator.LoadProfileCollection ethos_penalps.load_profile_calculator.ProcessStepEnergyDataHandler ethos_penalps.load_profile_calculator.StreamSpecificEnergyDataHandler ethos_penalps.load_profile_calculator.LoadProfileHandler .. py:class:: StreamLoadProfileEntryCollection .. py:attribute:: object_name :type: str .. py:attribute:: load_type_dict :type: dict[str, ethos_penalps.data_classes.LoadType] .. py:attribute:: dict_of_load_entry_lists :type: dict[str, list[ethos_penalps.data_classes.LoadProfileEntry]] .. py:method:: add_load_profile(load_type: ethos_penalps.data_classes.LoadType, load_profile_entry: ethos_penalps.data_classes.LoadProfileEntry) .. py:class:: ProcessStepLoadProfileEntryCollection .. py:attribute:: object_name :type: str .. py:attribute:: load_type_dict :type: dict[str, ethos_penalps.data_classes.LoadType] .. py:attribute:: dict_of_load_entry_lists :type: dict[str, list[ethos_penalps.data_classes.LoadProfileEntry]] .. py:method:: add_load_profiles(load_type: ethos_penalps.data_classes.LoadType, load_profile_entry: ethos_penalps.data_classes.LoadProfileEntry) .. py:class:: LoadProfileMetaDataFrameCollection .. py:attribute:: process_step_load_profile_meta_data_frame :type: dict[str, dict[ethos_penalps.data_classes.LoadType, ethos_penalps.data_classes.LoadProfileDataFrameMetaInformation]] .. py:attribute:: dict_stream_data_frames :type: dict[str, dict[ethos_penalps.data_classes.LoadType, ethos_penalps.data_classes.LoadProfileDataFrameMetaInformation]] .. py:attribute:: target_power_unit :type: str .. py:attribute:: target_energy_unit :type: str .. py:class:: LoadProfileCollection .. py:attribute:: dict_stream_load_profile_collections :type: dict[str, StreamLoadProfileEntryCollection] .. py:attribute:: dict_process_step_load_profile_collections :type: dict[str, ProcessStepLoadProfileEntryCollection] .. py:attribute:: list_of_load_type :type: list[ethos_penalps.data_classes.LoadType] .. py:attribute:: dict_stream_data_frames :type: dict[str, dict[ethos_penalps.data_classes.LoadType, pandas.DataFrame]] .. py:attribute:: dict_process_step_data_frames :type: dict[str, dict[ethos_penalps.data_classes.LoadType, pandas.DataFrame]] .. py:attribute:: dict_stream_data_frames_gantt_chart :type: dict[str, dict[ethos_penalps.data_classes.LoadType, pandas.DataFrame]] .. py:attribute:: dict_process_step_data_frames_gantt_chart :type: dict[str, dict[ethos_penalps.data_classes.LoadType, pandas.DataFrame]] .. py:attribute:: target_power_unit :type: str .. py:attribute:: target_energy_unit :type: str .. py:method:: append_stream_load_profile_entry(stream_name: str, load_type: ethos_penalps.data_classes.LoadType, load_profile_entry: ethos_penalps.data_classes.LoadProfileEntry) .. py:method:: append_process_step_energy_data_entry(process_step_name: str, load_type: ethos_penalps.data_classes.LoadType, load_profile_entry: ethos_penalps.data_classes.LoadProfileEntry) .. py:method:: convert_stream_energy_dict_to_data_frame() -> dict[str, dict[str, pandas.DataFrame]] .. py:method:: convert_process_state_energy_date() -> dict[str, dict[str, pandas.DataFrame]] .. py:method:: convert_all_load_lists_to_gantt_chart_data_frames(start_date: datetime.datetime, end_date: datetime.datetime, convert_stream_load_profile_entries: bool = True, convert_process_state_load_profiles: bool = True) .. py:class:: ProcessStepEnergyDataHandler Contains the specific energy data to convert the production plan to load profiles .. py:attribute:: process_step_name :type: str .. py:attribute:: process_state_energy_dict :type: dict[str, ethos_penalps.data_classes.ProcessStateEnergyData] .. py:attribute:: dict_of_load_type :type: dict[str, ethos_penalps.data_classes.LoadType] .. py:method:: get_process_state_energy_data(process_state_name: str) -> ethos_penalps.data_classes.ProcessStateEnergyData .. py:method:: get_dict_of_load_type() -> dict[str, ethos_penalps.data_classes.LoadType] .. py:method:: add_process_state_energy_data(process_state_name: str, process_state_energy_data: ethos_penalps.data_classes.ProcessStateEnergyData) .. py:class:: StreamSpecificEnergyDataHandler .. py:attribute:: stream_energy_data_dict :type: dict[str, ethos_penalps.stream.StreamEnergyData] .. py:attribute:: dict_of_all_load_types :type: dict[str, ethos_penalps.data_classes.LoadType] .. py:method:: add_stream_energy_data(stream_energy_data: ethos_penalps.stream.StreamEnergyData) .. py:method:: get_stream_energy_data(stream_name: str) -> ethos_penalps.stream.StreamEnergyData .. py:method:: get_list_of_load_types() -> dict[str, ethos_penalps.data_classes.LoadType] .. py:class:: LoadProfileHandler .. py:method:: get_list_of_load_types() -> list[ethos_penalps.data_classes.LoadType] .. py:method:: get_list_of_list_of_all_load_profile_entries() -> list[list[ethos_penalps.data_classes.LoadProfileEntry]] .. py:method:: create_load_profile_entry_from_stream_entry(stream_entry: ethos_penalps.stream.ContinuousStreamProductionPlanEntry | ethos_penalps.stream.BatchStreamProductionPlanEntry, stream_energy_data: ethos_penalps.data_classes.StreamLoadEnergyData) -> ethos_penalps.data_classes.LoadProfileEntry .. py:method:: create_all_load_profiles_entries_from_stream_entry(stream_entry: ethos_penalps.stream.ContinuousStreamProductionPlanEntry | ethos_penalps.stream.BatchStreamProductionPlanEntry) .. py:method:: add_process_state_energy_data(process_step_name: str, process_state_name: str, process_state_energy_data: ethos_penalps.data_classes.ProcessStateEnergyData) .. py:method:: get_process_step_energy_data_collection(process_step_name: str) -> ProcessStepEnergyDataHandler .. py:method:: create_all_load_profiles_from_process_state_entry(process_state_entry: ethos_penalps.data_classes.ProcessStepProductionPlanEntry)