Code Reference

This page gives an overview of all public marmot objects, functions and methods

• Initialization
  • Marmot Formatter
    • marmot.marmot_h5_formatter
  • Marmot Plotter
    • marmot.marmot_plot_main
• Formatters
  • Parent Class and Extra Properties Processing
    • marmot.formatters.formatbase.Process
    • marmot.formatters.formatextra.ExtraProperties
    • marmot.formatters.formatextra.ExtraPLEXOSProperties
    • marmot.formatters.formatextra.ExtraReEDSProperties
    • marmot.formatters.formatextra.ExtraReEDSIndiaProperties
    • marmot.formatters.formatextra.ExtraSIIProperties
  • PLEXOS
    • marmot.formatters.formatplexos.ProcessPLEXOS
  • ReEDS
    • marmot.formatters.formatreeds.ProcessReEDS
    • marmot.formatters.formatreeds.ReEDSPropertyColumns
  • ReEDS India
    • marmot.formatters.formatreeds_india.ProcessReEDSIndia
    • marmot.formatters.formatreeds_india.ReEDSIndiaPropertyColumns
  • SIIP
    • marmot.formatters.formatsiip.ProcessSIIP
  • EGRET
    • marmot.formatters.formategret.ProcessEGRET
• Meta Data
  • marmot.metamanagers.read_metadata.MetaData
  • marmot.metamanagers.write_siip_metadata
    • marmot.metamanagers.write_siip_metadata.META_KEYS_TO_FUNCTIONS
    • marmot.metamanagers.write_siip_metadata.format_generator_category_meta
    • marmot.metamanagers.write_siip_metadata.format_region_generators_meta
    • marmot.metamanagers.write_siip_metadata.format_region_interregionallines
    • marmot.metamanagers.write_siip_metadata.format_region_intraregionallines
    • marmot.metamanagers.write_siip_metadata.format_regions_meta
    • marmot.metamanagers.write_siip_metadata.format_reserve_generators_meta
    • marmot.metamanagers.write_siip_metadata.metadata_to_h5
• Plots
  • marmot.plottingmodules.capacity_factor.CapacityFactor
  • marmot.plottingmodules.capacity_out.CapacityOut
  • marmot.plottingmodules.curtailment.Curtailment
  • marmot.plottingmodules.emissions.Emissions
  • marmot.plottingmodules.generation_stack.GenerationStack
  • marmot.plottingmodules.generation_unstack.GenerationUnStack
  • marmot.plottingmodules.hydro.Hydro
  • marmot.plottingmodules.prices.Prices
  • marmot.plottingmodules.production_cost.SystemCosts
  • marmot.plottingmodules.ramping.Ramping
  • marmot.plottingmodules.reserves.Reserves
  • marmot.plottingmodules.sensitivities.Sensitivities
  • marmot.plottingmodules.storage.Storage
  • marmot.plottingmodules.thermal_cap_reserve.ThermalReserve
  • marmot.plottingmodules.total_generation.TotalGeneration
  • marmot.plottingmodules.total_installed_capacity.InstalledCapacity
  • marmot.plottingmodules.transmission.Transmission
  • marmot.plottingmodules.unserved_energy.UnservedEnergy
  • marmot.plottingmodules.utilization_factor.UtilizationFactor
• Plot Utilities
  • Plotting Engines
    • marmot.plottingmodules.plotutils.plot_library.SetupSubplot
    • marmot.plottingmodules.plotutils.plot_library.PlotLibrary
  • Data Storage and Processing
    • marmot.plottingmodules.plotutils.plot_data_helper.PlotDataStoreAndProcessor
    • marmot.plottingmodules.plotutils.plot_data_helper.GenCategories
    • marmot.plottingmodules.plotutils.timeseries_modifiers
  • Plot Design
    • marmot.plottingmodules.plotutils.styles
  • Plot Exceptions
    • marmot.plottingmodules.plotutils.plot_exceptions
• Utilities
  • Output Logs
    • marmot.utils.loggersetup.SetupLogger
  • Definitions and Configuration
    • marmot.utils.definitions
    • marmot.utils.mconfig
  • Data Input/Output
    • marmot.utils.dataio
  • Error and Exception Classes
    • marmot.utils.error_handler.MissingH5PLEXOSDataError
    • marmot.utils.error_handler.PropertyNotFound
    • marmot.utils.error_handler.ConfigFileReadError
    • marmot.utils.error_handler.ReEDSColumnLengthError
    • marmot.utils.error_handler.ReEDSYearTypeConvertError