Timeseq

Timeseq

PySAM.Timeseq.default(config) → Timeseq

Load defaults for the configuration config. Available configurations are:

None

Note

Some inputs do not have default values and may be assigned a value from the variable’s Required attribute. See variable attribute descriptions below.

PySAM.Timeseq.from_existing(data, optional config) → Timeseq: Share data with an existing PySAM class. If optional config is a valid configuration name, load the module’s defaults for that configuration.

PySAM.Timeseq.new() → Timeseq

PySAM.Timeseq.wrap(ssc_data_t) → Timeseq: Load data from a PySSC object.

Warning

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

Timeseq is a wrapper for the SSC compute module cmod_timeseq.cpp

Interdependent Variables

The variables listed below are interdependent with other variables. If you change the value of one of these variables, you may need to change values of other variables. The SAM user interface manages these interdependent variables, but in PySAM, it is up to you change the value of all interdependent variables so they are consistent. See Interdependent Variables for examples and details.

None

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

get_data_ptr() → Pointer: Get ssc_data_t pointer

replace(dict) → None

Replace attributes from nested dictionary, except for Outputs. Unassigns all values in each Group then assigns from the input dict.

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

unassign(name) → None: Unassign a value in any of the variable groups.

value(name, optional value) → 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(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

TimeSequence_vals = { var: val, ...}

export() → dict: Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

TimeSequence_vals = { var: val, ...}

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(dict) → None

Assign attributes from dictionary, overwriting but not removing values.

Outputs_vals = { var: val, ...}

export() → dict: Export attributes into dictionary.

replace(dict) → None

Replace attributes from dictionary, unassigning values not present in input dict.

Outputs_vals = { var: val, ...}

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