ScenarioSet

(class from pyomo.contrib.parmest.scenariocreator)

class pyomo.contrib.parmest.scenariocreator.ScenarioSet(name)[source]

Bases: object

Class to hold scenario sets

Args: name (str): name of the set (might be “”)

__init__(name)[source]

Methods

ScenarioNumber(scennum)

Returns the scenario with the given, zero-based number

ScensIterator()

Usage: for scenario in ScensIterator()

__init__(name)

addone(scen)

Add a scenario to the set

append_bootstrap(bootstrap_theta)

Append a bootstrap theta df to the scenario set; equally likely

write_csv(filename)

write a csv file with the scenarios in the set

Member Documentation

ScenarioNumber(scennum)[source]

Returns the scenario with the given, zero-based number

ScensIterator()[source]

Usage: for scenario in ScensIterator()

addone(scen)[source]

Add a scenario to the set

Parameters:

scen (ParmestScen) – the scenario to add

append_bootstrap(bootstrap_theta)[source]

Append a bootstrap theta df to the scenario set; equally likely

Parameters:

bootstrap_theta (dataframe) – created by the bootstrap

Note: this can be cleaned up a lot with the list becomes a df,

which is why I put it in the ScenarioSet class.

write_csv(filename)[source]

write a csv file with the scenarios in the set

Parameters:

filename (str) – full path and full name of file