dispaset package

Subpackages

• dispaset.preprocessing package
  • Submodules
  • dispaset.preprocessing.data_check module
    • check_AvailabilityFactors()
    • check_FlexibleDemand()
    • check_MinMaxFlows()
    • check_NonNaNKeys()
    • check_PtLDemand()
    • check_StrKeys()
    • check_chp()
    • check_clustering()
    • check_df()
    • check_h2()
    • check_heat()
    • check_heat_demand()
    • check_keys()
    • check_p2h()
    • check_reserves()
    • check_simulation_environment()
    • check_sto()
    • check_temperatures()
    • check_units()
    • isStorage()
    • isVRE()
  • dispaset.preprocessing.data_handler module
    • GenericTable()
    • NodeBasedTable()
    • UnitBasedTable()
    • define_parameter()
    • export_yaml_config()
    • load_config()
    • load_config_excel()
    • load_config_yaml()
    • load_geo_data()
    • load_time_series()
    • merge_series()
    • read_Participation()
    • read_truefalse()
  • dispaset.preprocessing.preprocessing module
    • build_simulation()
    • mid_term_scheduling()
  • dispaset.preprocessing.utils module
    • EfficiencyTimeSeries()
    • adjust_capacity()
    • adjust_flexibility()
    • adjust_ntc()
    • adjust_unit_capacity()
    • clustering()
    • create_agg_dict()
    • group_plants()
    • incidence_matrix()
    • interconnections()
    • pd_timestep()
    • select_units()
  • Module contents
• dispaset.postprocessing package
  • Submodules
  • dispaset.postprocessing.postprocessing module
    • Cashflows()
    • CostExPost()
    • aggregate_by_fuel()
    • curtailment()
    • emissions()
    • filter_by_heating_zone()
    • filter_by_storage()
    • filter_by_tech()
    • filter_by_tech_list()
    • filter_by_zone()
    • get_EFOH()
    • get_from_to_flows()
    • get_heat_plot_data()
    • get_imports()
    • get_indicators_powerplant()
    • get_load_data()
    • get_net_positions()
    • get_plot_data()
    • get_power_flow_tracing()
    • get_result_analysis()
    • get_units_operation_cost()
    • load_shedding()
    • reserve_availability_demand()
    • shadowprices()
  • Module contents
• dispaset.misc package
  • Submodules
  • dispaset.misc.colorstreamhandler module
    • ColorStreamHandler
  • dispaset.misc.gdx_handler module
    • gdx_to_dataframe()
    • gdx_to_list()
    • get_gams_path()
    • get_gdx()
    • import_local_lib()
    • package_exists()
    • write_variables()
  • dispaset.misc.str_handler module
    • clean_strings()
    • force_str()
    • shrink_to_64()
  • Module contents

Submodules

dispaset.solve module

This worksheet contains the two main functions to solve the DispaSET optimization problem using GAMS.

Solve with GAMS and the high level API

The high level interface is recommended for Linux users because it solves the “whitespace in the simulation folder” issue.

Installation:

To install the high-level API in Python 2.x:

cd gams24.4_linux_x64_64_sfx/apifiles/Python/api
python gamssetup.py install

To install the high-level API in Python 3.x:

cd gams24.6_linux_x64_64_sfx/apifiles/Python/api_34
python setup.py install    

Solve with GAMS and the low level APIs

Use lower level apis to run GAMS. BAsed on GAMS xpexample2.py

The advantage of the low level API is that it can easily be installed from pip:

pip install gdxcc
pip install gamsxcc
pip install optcc

dispaset.solve.is_sim_folder_ok(sim_folder)

Function that checks if the provided path is a valid Dispa-SET simulation folder. The following files are required:

• Inputs.gdx

• UCM_h.gms

Parameters:

sim_folder – path (absolute or relative) to the simulation folder

dispaset.solve.solve_GAMS(sim_folder, gams_folder=None, gams_file='UCM_h.gms', result_file='Results.gdx', output_lst=False)

Function used to run the optimization using the GAMS engine.

Parameters:

• sim_folder – path to a valid Dispa-SET simulation folder

• gams_folder – path to the gams folder. If not provided, the script will try to find it automatically

• work_dir – path to the working directory (does not need to be provided)

• output_lst – Set to True to conserve a copy of the GAMS lst file in the simulation folder

Module contents