arrow-left

All pages
gitbookPowered by GitBook
1 of 4

Loading...

Loading...

Loading...

Loading...

Indexed Array Parameter

hashtag
General Description

Parameter which uses an IndexParameter to index an array of Parameters.

An example use of this parameter is to return a demand saving factor (as a float) based on the current demand saving level (calculated by an IndexParameter). API Referencearrow-up-right

hashtag
Attributes

Name
Description
Required

hashtag
Example

The above code uses the Index supplied by the parameter called 'Reservoir control curve', which is a Index 0 returns a 1, Index 2 returns 0.9 etc...

In this example this parameter is used to reduce a demand based on a reservoir control curve. Please go to the to see how this is done.

Please see how the Reservoir control curve parameter is defined.

index_parameter

IndexParameter

Yes

params

iterable of Parameters or floats

Yes

Control Curve Index Parameter.arrow-up-right
Aggregated Parameter examplearrow-up-right
{
	"type": "indexedarrayparameter",
	"index_parameter": "Reservoir control curve",
	"params": [
		1,
		0.9,
		0.8,
		0.5
	]
}

Array Indexed Parameter

hashtag
General Description

Time varying parameter using an array and Timestep.index

The values in this parameter are constant across all scenarios. API Referencearrow-up-right

hashtag
Attributes

Name
Description
Required

hashtag
Example

coming soon...

{

}

Array Based Parameters

Array Indexed Scenario Parameter

hashtag
General Description

A Scenario varying Parameter.

The values in this parameter are vary in time based on index and vary within a single Scenario. API Referencearrow-up-right

hashtag
Attributes

Name
Description
Required

hashtag
Example

coming soon...

{

}