Utilities#

Utility classes and functions needed by Marmot. Includes things such as logger setup and config file parsers.

Output Logs#

SetupLogger(logger_type[, log_directory, ...])

Sets up the python logger.

Definitions and Configuration#

definitions

Module to set correct project and file paths.

mconfig

This module creates the default config.yml file that is used by Marmot.

Data Input/Output#

dataio

Module containing all data import and export functions

Error and Exception Classes#

MissingH5PLEXOSDataError(h5_file)

Raise when the data key in the H5PLEXOS file is empty

PropertyNotFound(property, prop_class)

Raise when the get_processed_data method cannot find the specified property in the simulation model solution files

ConfigFileReadError(key)

Raise when a requested key cannot be found in the config.yml file

ReEDSColumnLengthError(df, prop_columns, ...)

Raised when there is a length mismatch between ReEDS df and ReEDSPropertyColumns

ReEDSYearTypeConvertError(df, prop, ...)

Raised when ReEDS df.year column cannot be converted to type int

New in version 0.11.0.