Typing aliases (thermoextrap.core.typing)

Classes:

DataT	Type variable for DataArray or Dataset.
T_co	Generic covariant type variable.
SupportsIdentityTransform(*args, **kwargs)	Callable for identity transform.
SupportsGetItem(*args, **kwargs)	Protocol for thing that container that supports __getitem__
SupportsData(*args, **kwargs)	Protocol for Data
SupportsDataXU(*args, **kwargs)	Data protocol for PerturbModel
SupportsModel(*args, **kwargs)	Protocol for single model.
SupportsModelDerivs(*args, **kwargs)	Protocol for single model with derivs
SupportsModelDataT	Generic type variable for SupportsModel
SupportsModelDataT_co	Generic type variable for SupportsModel
SupportsModelDerivsDataT	Generic type variable for SupportsModelDerivs
SupportsModelDerivsDataArrayT	Generic type variable for SupportsModelDerivs with DataArray
SupportsModelT_co	Generic covariant type variable for SupportsModel
SupportsStateCollection(states, *[, kws])	Protocol for State collection

class thermoextrap.core.typing.DataT

Type variable for DataArray or Dataset.

alias of TypeVar(‘DataT’, ~xarray.core.dataarray.DataArray, ~xarray.core.dataset.Dataset)

class thermoextrap.core.typing.T_co

Generic covariant type variable.

alias of TypeVar(‘T_co’, covariant=True)

class thermoextrap.core.typing.SupportsIdentityTransform(*args, **kwargs)

Bases: Protocol

Callable for identity transform.

Methods:

__call__(x, y, y_var)

Call self as a function.

__call__(x, y, y_var)

Call self as a function.

class thermoextrap.core.typing.SupportsGetItem(*args, **kwargs)

Bases: Protocol[T_co]

Protocol for thing that container that supports __getitem__

class thermoextrap.core.typing.SupportsData(*args, **kwargs)

Bases: Protocol[T_co]

Protocol for Data

class thermoextrap.core.typing.SupportsDataXU(*args, **kwargs)

Bases: Protocol[T_co]

Data protocol for PerturbModel

class thermoextrap.core.typing.SupportsModel(*args, **kwargs)

Bases: Protocol[T_co]

Protocol for single model.

class thermoextrap.core.typing.SupportsModelDerivs(*args, **kwargs)

Bases: SupportsModel[T_co], Protocol[T_co]

Protocol for single model with derivs

class thermoextrap.core.typing.SupportsModelDataT

Generic type variable for SupportsModel

alias of TypeVar(‘SupportsModelDataT’, bound=SupportsModel[DataArray | Dataset])

class thermoextrap.core.typing.SupportsModelDataT_co

Generic type variable for SupportsModel

alias of TypeVar(‘SupportsModelDataT_co’, bound=SupportsModel[DataArray | Dataset], covariant=True)

class thermoextrap.core.typing.SupportsModelDerivsDataT

Generic type variable for SupportsModelDerivs

alias of TypeVar(‘SupportsModelDerivsDataT’, bound=SupportsModelDerivs[DataArray | Dataset])

class thermoextrap.core.typing.SupportsModelDerivsDataArrayT

Generic type variable for SupportsModelDerivs with DataArray

alias of TypeVar(‘SupportsModelDerivsDataArrayT’, bound=SupportsModelDerivs[DataArray])

class thermoextrap.core.typing.SupportsModelT_co

Generic covariant type variable for SupportsModel

alias of TypeVar(‘SupportsModelT_co’, bound=SupportsModel[Any], covariant=True)

class thermoextrap.core.typing.SupportsStateCollection(states, *, kws=None)

Bases: Protocol[T_co, SupportsModelT_co]

Protocol for State collection

Methods:

resample(sampler, **kws)

Resample underlying models.

resample(sampler, **kws)

Resample underlying models.

If pass in a single sampler, use it for all states. For example, to resample all states with some nrep, use .resample(sampler={"nrep": nrep}). Note that the if you pass a single mapping, the mapping will be passed to each state resample method, which will in turn create unique sample for each state. To specify a different sampler for each state, pass in a sequence of sampler.