Types

Define the types every layer of the package reads: arrays, tuples, functions, keys, and kinds.

`DataKind`

Bases: StrEnum

Kind of data an analysis consumes, whatever model or measurement produced it.

A kind equals its value, so an analysis may return the plain string, such as 'series'.

Examples:

>>> from skcomplex.types import DataKind
>>> DataKind('field').reading
'a grid of values, or frames of grids'
>>> DataKind.SERIES == 'series'
True

Plain arrays or graphs the analyses of the kind read.

Bases: StrEnum

Kind of value a state takes, which decides the laws that may target it.

Bases: StrEnum

Kind of element or system that carries states, as solvers and backends support them.

Bases: StrEnum

Mathematical form of a compiled system, which decides the solvers that advance it.

Examples:

>>> from skcomplex.types import FormKind
>>> FormKind.SDE.value
'stochastic differential equations'

Bases: StrEnum

Structure of the Wiener processes that the noise laws of a system draw.

Bases: StrEnum

Kind of order of the time derivative that the rate laws on a state give.

Bases: StrEnum

Role a declared argument plays in a part.