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 of the engine, in PEP 440 notation. Every result records it in its provenance. |
|
An estimator breaks the contract. Raised by the contract kit. |
|
Return the registry of the installed entry points, read once per process. |
|
A fully specified computation that reads one input and returns a |
|
An estimator class does not declare its identity. |
|
One entry of the registry. |
|
Interval around an estimate. |
|
The data handed over is not what the method reads, or breaks an invariant. |
|
A setting is outside its documented range. |
|
Identity of a method. |
|
An optional dependency is not installed. |
|
What it takes to redo a result and to cite it. |
|
Pseudo-random generator used by a computation, and its seed. |
|
Immutable mapping from |
|
The only type a method of the engine returns. |
|
Root of every error raised by SELENE. |
|
Standard error of an estimate. |
|
An explained absence of value. |
|
The value of a result that has none was read. |
|
Why a method has no value to return. |
|
Uncertainty of a value. |
|
A registry key does not exist. |