civiqhub_selene

SELENE, the open scientific engine of CiviqHub.

The package root holds the contract every method shares, on the standard library alone: the errors, the result types, the base class of estimators and the registry. The contract kit lives in civiqhub_selene.testing. Methods live in subpackages (ordinal, blocks) and are added together with their first tested implementation, never as placeholders.

Importing civiqhub_selene loads neither NumPy nor the civiqhub SDK.

civiqhub_selene.__version__

Version of the engine, in PEP 440 notation. Every result records it in its provenance.

Exported names

These names are imported from civiqhub_selene. Each one links to the module that defines it.

Name

What it is

__version__

Version of the engine, in PEP 440 notation. Every result records it in its provenance.

ContractError

An estimator breaks the contract. Raised by the contract kit.

default_registry

Return the registry of the installed entry points, read once per process.

Estimator

A fully specified computation that reads one input and returns a Result.

EstimatorDefinitionError

An estimator class does not declare its identity.

EstimatorSpec

One entry of the registry.

Interval

Interval around an estimate.

InvalidInputError

The data handed over is not what the method reads, or breaks an invariant.

InvalidParameterError

A setting is outside its documented range.

Method

Identity of a method.

MissingExtraError

An optional dependency is not installed.

Provenance

What it takes to redo a result and to cite it.

Randomness

Pseudo-random generator used by a computation, and its seed.

Registry

Immutable mapping from family.choice keys to EstimatorSpec.

Result

The only type a method of the engine returns.

SeleneError

Root of every error raised by SELENE.

StandardError

Standard error of an estimate.

Unavailable

An explained absence of value.

UnavailableError

The value of a result that has none was read.

UnavailableReason

Why a method has no value to return.

Uncertainty

Uncertainty of a value. None in a result means “not defined”, never “zero”.

UnknownEstimatorError

A registry key does not exist.

Modules