omegalpes.general package

Subpackages

• omegalpes.general.optimisation package
  • Submodules
  • omegalpes.general.optimisation.core module
    • OptObject
      • OptObject.deactivate_optobject_external_constraints()
      • OptObject.get_actor_constraints_list()
      • OptObject.get_actor_constraints_name_list()
      • OptObject.get_constraints_list()
      • OptObject.get_constraints_name_list()
      • OptObject.get_objectives_list()
      • OptObject.get_objectives_name_list()
      • OptObject.get_quantities_list()
      • OptObject.get_quantities_name_list()
      • OptObject.get_technical_constraints_list()
      • OptObject.get_technical_constraints_name_list()
  • omegalpes.general.optimisation.elements module
    • ActorConstraint
      • ActorConstraint.deactivate_constraint()
    • ActorDynamicConstraint
    • Constraint
    • DailyDynamicConstraint
    • DefinitionConstraint
    • DefinitionDynamicConstraint
    • DynamicConstraint
    • ExtDynConstraint
    • ExternalConstraint
      • ExternalConstraint.deactivate_constraint()
    • HourlyDynamicConstraint
    • Objective
    • Quantity
      • Quantity.get_value()
      • Quantity.get_value_with_date()
    • TechnicalConstraint
      • TechnicalConstraint.deactivate_constraint()
    • TechnicalDynamicConstraint
  • omegalpes.general.optimisation.model module
    • OptimisationModel
      • OptimisationModel.add_nodes()
      • OptimisationModel.add_nodes_and_actors()
      • OptimisationModel.get_model_constraints_list()
      • OptimisationModel.get_model_constraints_name_list()
      • OptimisationModel.get_model_objectives_list()
      • OptimisationModel.get_model_objectives_name_list()
      • OptimisationModel.get_model_quantities_list()
      • OptimisationModel.get_model_quantities_name_list()
      • OptimisationModel.solve_and_update()
      • OptimisationModel.update_units()
    • check_if_unit_could_have_parent()
    • compute_gurobi_IIS()
  • Module contents
• omegalpes.general.utils package
  • Submodules
  • omegalpes.general.utils.input_data module
    • read_enedis_data_csv_file()
    • resample_data()
    • select_csv_file_between_dates()
  • omegalpes.general.utils.maths module
    • def_abs_value()
  • omegalpes.general.utils.output_data module
    • save_energy_flows()
  • omegalpes.general.utils.plots module
    • plot_energy_mix()
    • plot_node_energetic_flows()
    • plot_pareto2D()
    • plot_quantity()
    • plot_quantity_bar()
    • sum_quantities_in_quantity()
  • Module contents

Submodules

omegalpes.general.time module

This module creates the Time object

class omegalpes.general.time.TimeUnit(start='01/01/2018', end=None, periods=None, dt=1, verbose=True)

Bases: object

Description

Class defining the studied time period.

Attributes

• DATES : dated list of simulation steps

• DT : delta t between values in hours (int or float), i.e. 1/6 will be 10 minutes.

• LEN : number of simulation steps (length of DATES)

• I : index of time ([0 : LEN])

get_date_for_index(index)

Getting a date for a given index

Parameters:

index – int value for the index of the wanted dated, between 0 and LEN (it must be in the studied period)

property get_days

Getting days for the studied period

Return all_days:

list of days of the studied period

get_index_for_date(date='YYYY-MM-DD HH:MM:SS')

Getting the index associated with a date

Parameters:

date – date the index of is wanted. Format YYYY-MM-DD HH:MM:SS, must be within the studied period and consistent with the timestep value

get_index_for_date_range(starting_date='YYYY-MM-DD HH:MM:SS', end=None, periods=None)

Getting a list of index for a date range

Parameters:

• starting_date – starting date of the wanted index

• end – ending date of the wanted index

• periods – number of periods from the starting_date of the wanted index

Return index_list:

list of indexes for the given dates

get_non_working_dates(month_range=range(0, 12), hour_range=range(0, 24), country='France')

get_non_working_days(country='France')

get_working_dates(month_range=range(0, 12), hour_range=range(0, 24), country='France')

get_working_days(country='France')

print_studied_period()

omegalpes.general.time.convert_european_format(date)

Converting a date with an european format DD/MM/YYYY into a datetime format YYYY-MM-DD or return

Parameters:

date – date in european format

Returns:

date in format datetime

Module contents