1 of 8

Threshold Parameters

Abstract Threshold

General Description

Base class for parameters returning one of two values depending on other state. API Reference

Attributes

Name

Description

Required

threshold

Threshold to compare the value of the recorder to

Yes

values

If the predicate evaluates False the zeroth value is returned, otherwise the first value is returned

Yes

predicate

One of {“LT”, “GT”, “EQ”, “LE”, “GE”}

Yes

ratchet

If true the parameter behaves like a ratchet. Once it is triggered first it stays in the triggered position (default=False)

Yes

Example

coming soon...

{

}

Storage Threshold

General Description

Returns one of two values depending on current volume in a Storage node. API Reference

Attributes

Name

Description

Required

threshold

Threshold to compare the value of the recorder to

Yes

storage

storage: pywr._core.AbstractStorage

Yes

ratchet

If true the parameter behaves like a ratchet. Once it is triggered first it stays in the triggered position (default=False)

Yes

Example

coming soon...

{

}

Node Threshold

General Description

Returns one of two values depending on previous flow in a node.

Attributes

Name

Description

Required

Example

coming soon...

Parameter Threshold

General Description

Returns one of two values depending on the value of a Parameter. API Reference

Attributes

Name

Description

Required

threshold

Threshold to compare the value of the recorder to

Yes

ratchet

If true the parameter behaves like a ratchet. Once it is triggered first it stays in the triggered position (default=False)

Yes

Example

coming soon...

{

}

Recorder Threshold

General Description

Returns one of two values depending on a Recorder value and a threshold. API Reference

Attributes

Name

Description

Required

threshold

Threshold to compare the value of the recorder to

Yes

ratchet

If true the parameter behaves like a ratchet. Once it is triggered first it stays in the triggered position (default=False)

Yes

recorder

recorder: pywr.recorders._recorders.Recorder

Example

coming soon...

{

}

Current Year Threshold

General Description

Returns one of two values depending on the year of the current timestep. API Reference

Attributes

Name

Description

Required

threshold

Threshold to compare the value of the recorder to

Yes

ratchet

If true the parameter behaves like a ratchet. Once it is triggered first it stays in the triggered position (default=False)

Yes

Example

coming soon...

{

}

Current Ordinal Day Threshold

General Description

Returns one of two values depending on the ordinal of the current timestep.

Attributes

Name

Description

Required

Example

coming soon...

Abstract Threshold

General Description

Base class for parameters returning one of two values depending on other state. API Reference

Attributes

Name

Description

Required

threshold

Threshold to compare the value of the recorder to

Yes

values

If the predicate evaluates False the zeroth value is returned, otherwise the first value is returned

Yes

predicate

One of {“LT”, “GT”, “EQ”, “LE”, “GE”}

Yes

ratchet

If true the parameter behaves like a ratchet. Once it is triggered first it stays in the triggered position (default=False)

Yes

Example

coming soon...

{

}