Timeseq

Wrapper for SAM Simulation Core model: cmod_timeseq.cpp

Creating an Instance

There are three methods to create a new instance of a PySAM module. Using default populates the newclass’ attributes with default values specific to a config. Each technology-financialconfiguration corresponds to a SAM GUI configuration. Using new creates an instance with empty attributes. The wrap function allows compatibility with PySSC, for details, refer to PySSC.

Timeseq model description

Timeseq

PySAM.Timeseq.default(config) → Timeseq

Use financial config-specific default attributes

PySAM.Timeseq.from_existing(data, optional config) → Timeseq

Share underlying data with an existing PySAM class. If config provided, default attributes are loaded otherwise.

PySAM.Timeseq.new() → Timeseq
PySAM.Timeseq.wrap(ssc_data_t) → Timeseq

Use existing PySSC data

Warning

Do not call PySSC.data_free on the ssc_data_t provided to wrap

Functions

class PySAM.Timeseq.Timeseq

This class contains all the variable information for running a simulation. Variables are grouped together in the subclasses as properties. If property assignments are the wrong type, an error is thrown.

assign(dict) → None

Assign attributes from nested dictionary, except for Outputs

nested_dict = { 'Time Sequence': { var: val, ...}, ...}

execute(int verbosity) → None

Execute simulation with verbosity level 0 (default) or 1

export() → dict

Export attributes into nested dictionary

value(name, optional value) → Union[None, float, dict, sequence, str]

Get or set by name a value in any of the variable groups.

TimeSequence Group

class PySAM.Timeseq.Timeseq.TimeSequence
assign() → None

Assign attributes from dictionary

TimeSequence_vals = { var: val, ...}

export() → dict

Export attributes into dictionary

end_time

End time [seconds]

Options: 0=jan1st 12am

Constraints: MIN=0,MAX=31536000

Required: True

Type:float
start_time

Start time [seconds]

Options: 0=jan1st 12am

Constraints: MIN=0,MAX=31536000

Required: True

Type:float
time_step

Time step [seconds]

Constraints: MIN=1,MAX=3600

Required: True

Type:float

Outputs Group

class PySAM.Timeseq.Timeseq.Outputs
assign() → None

Assign attributes from dictionary

Outputs_vals = { var: val, ...}

export() → dict

Export attributes into dictionary

day

Day

Type:sequence
hour

Hour

Type:sequence
minute

Minute

Type:sequence
month

Month

Type:sequence
time

Time [secs]

Type:sequence
timehr

HourTime [hours]

Type:sequence