Reference docs

pommesdispatch.cli

cli.py is the command line interface. The method run_pommes_dispatch triggers a pommesdispatch model run. For usage please see Using pommesdispatch.

pommesdispatch.model

The pommesdispatch.model package contains the actual model which is a single file dispatch_model.py.

pommesdispatch.model_funcs

The pommesdispatch.model_funcs package contains a collection of functions, classes and methods that are needed to create a dispatch model in pommesdispatch.model.dispatch_model.py.

Modules

  • model_control.py: Controls a model workflow consisting of defining a model configuration, controlling logging information, reading in input data, building and solving an oemof.solph model and a pyomo model. The class DispatchModel holds parameterization information as well as methods in order to control the model workflow. Makes use of the modules data_input.py as well as helpers.py.

  • data_input.py: Holds functions to parse input data from .csv files and to create oemof.solph components (see oemof.solph’s user’s guide) out of it. Optionally includes an emissions limit.

  • subroutines.py: Includes all the functions to actually build the oemof.solph components given the provided input data. Is imported in the module data_input.py.

  • helpers.py: Includes some helper routines to support the model workflow that are imported in model_control.py resp. data_input.py in order to perform some calculations not directly related to the actual mathematical model, but facilitating its setup and parameterization.

For an in-depth documentation of all modules, functions, classes and methods, see the API Reference.