Skip to content
Eqiora

eqiora

← Python API index

Python ergonomics over Eqiora’s canonical Rust implementation.

Module authority: bindings/python/python/eqiora/init.py

Shipped stub: bindings/python/python/eqiora/init.pyi

This module publishes 77 literal __all__ spellings. Member entries below are exact signatures under documented owning types; they do not imply member-level behavioral prose.

__version__

Section titled “__version__”

Version export. The current value is intentionally not hard-coded in this generated page.

python
__version__: str

Array

Section titled “Array”

Immutable dense one-dimensional CPU float64 result buffer.

Authority: crates/eqiora-python/src/array.rs::PyArrayBuffer

python
@final
class Array:
    def __getitem__(self, index: int, /) -> float: ...
    def numpy(self, *, copy: bool | None=None) -> _Float64Array: ...
    def __array__(self, dtype: object | None=None, copy: bool | None=None) -> _Float64Array: ...
    def __dlpack_device__(self) -> tuple[int, int]: ...
    def __dlpack__(self, *, stream: int | None=None, max_version: tuple[int, int] | None=None, dl_device: tuple[int, int] | None=None, copy: bool | None=None) -> object: ...
    @property
    def device(self) -> str: ...
    @property
    def device_id(self) -> int: ...
    @property
    def dtype(self) -> str: ...
    @property
    def byte_order(self) -> str: ...
    @property
    def shape(self) -> tuple[int]: ...
    @property
    def strides(self) -> tuple[int]: ...
    @property
    def c_contiguous(self) -> bool: ...
    @property
    def aligned(self) -> bool: ...
    @property
    def readonly(self) -> bool: ...
    @property
    def ownership(self) -> str: ...
    @property
    def origin_copy_occurred(self) -> bool: ...
    def __len__(self) -> int: ...

BoundarySide

Section titled “BoundarySide”

Closed orientation of one Cartesian boundary domain.

Authority: crates/eqiora-python/src/modeling.rs::PyBoundarySide

python
@final
class BoundarySide:
    Lower: ClassVar[BoundarySide]
    Upper: ClassVar[BoundarySide]
    def __eq__(self, other: object, /) -> bool: ...
    def __hash__(self) -> int: ...

CancellationError

Section titled “CancellationError”

Failure reporting cancellation of an Eqiora operation.

Authority: crates/eqiora-python/src/error.rs::CancellationError

python
class CancellationError(EqioraError):
    ...

CapabilityError

Section titled “CapabilityError”

Failure caused by an adapter lacking a required capability.

Authority: crates/eqiora-python/src/error.rs::CapabilityError

python
class CapabilityError(EqioraError):
    ...

CompatibilityError

Section titled “CompatibilityError”

Failure caused by an incompatible versioned or persisted value.

Authority: crates/eqiora-python/src/error.rs::CompatibilityError

python
class CompatibilityError(EqioraError):
    ...

Connection

Section titled “Connection”

Immutable anonymous conserving connection declaration.

Authority: crates/eqiora-python/src/modeling.rs::PyConnection

python
@final
class Connection:
    ...

ConservingPort

Section titled “ConservingPort”

Immutable scalar conserving-port declaration.

Authority: crates/eqiora-python/src/modeling.rs::PyConservingPort

python
@final
class ConservingPort:
    def __new__(cls, name: str, *, domain: PhysicalDomain) -> Self: ...
    @property
    def name(self) -> str: ...
    @property
    def domain(self) -> PhysicalDomain: ...

ConvergenceReason

Section titled “ConvergenceReason”

Accepted reason for linear-solve convergence.

Authority: crates/eqiora-python/src/realization.rs::PyConvergenceReason

python
@final
class ConvergenceReason:
    InitialResidualSatisfied: ClassVar[ConvergenceReason]
    ResidualToleranceSatisfied: ClassVar[ConvergenceReason]
    def __eq__(self, other: object, /) -> bool: ...
    def __hash__(self) -> int: ...

DerivativeImplementation

Section titled “DerivativeImplementation”

Source of the derivative action used by an occurrence.

Authority: crates/eqiora-python/src/differentiation.rs::PyDerivativeImplementation

python
@final
class DerivativeImplementation:
    AnalyticAssembled: ClassVar[DerivativeImplementation]
    def __eq__(self, other: object, /) -> bool: ...
    def __hash__(self) -> int: ...

Diagnostic

Section titled “Diagnostic”

Immutable lossless projection of a current Rust diagnostic.

Authority: crates/eqiora-python/src/error.rs::PyDiagnostic

python
@final
class Diagnostic:
    @property
    def source(self) -> str: ...
    @property
    def code(self) -> str: ...
    @property
    def severity(self) -> str: ...
    @property
    def message(self) -> str: ...
    @property
    def graph_path(self) -> list[str] | None: ...
    @property
    def source_span(self) -> tuple[str, int, int] | None: ...
    @property
    def suggestion(self) -> str | None: ...

DifferentiableEvaluation

Section titled “DifferentiableEvaluation”

Immutable accepted evaluation at one numerical parameter point.

Authority: crates/eqiora-python/src/differentiation.rs::PyDifferentiableEvaluation

python
@final
class DifferentiableEvaluation:
    @property
    def point(self) -> Array: ...
    def primal(self) -> DifferentiablePrimal: ...
    def jvp(self, tangent: Array | _Float64Array | _DLPackProducer) -> DifferentiableJvp: ...
    def vjp(self, cotangent: Array | _Float64Array | _DLPackProducer) -> DifferentiableVjp: ...

DifferentiableJvp

Section titled “DifferentiableJvp”

Accepted primary field and its forward tangent.

Authority: crates/eqiora-python/src/differentiation.rs::PyDifferentiableJvp

python
@final
class DifferentiableJvp:
    @property
    def output(self) -> Array: ...
    @property
    def tangent(self) -> Array: ...
    @property
    def evidence(self) -> DifferentiationEvidence: ...

DifferentiablePrimal

Section titled “DifferentiablePrimal”

Accepted complete primary field from a primal evaluation.

Authority: crates/eqiora-python/src/differentiation.rs::PyDifferentiablePrimal

python
@final
class DifferentiablePrimal:
    @property
    def output(self) -> Array: ...
    @property
    def evidence(self) -> DifferentiationEvidence: ...

DifferentiableProgram

Section titled “DifferentiableProgram”

Immutable program over one fixed input-coordinate set.

Authority: crates/eqiora-python/src/differentiation.rs::PyDifferentiableProgram

python
@final
class DifferentiableProgram:
    @property
    def model_digest(self) -> str: ...
    @property
    def realization_digest(self) -> str: ...
    @property
    def input_ids(self) -> list[str]: ...
    @property
    def output_id(self) -> str: ...
    @property
    def input_shape(self) -> tuple[int]: ...
    @property
    def output_shape(self) -> tuple[int]: ...
    @property
    def dtype(self) -> str: ...
    @property
    def device(self) -> str: ...
    @property
    def derivative_contract(self) -> str: ...
    def evaluate(self, parameters: Array | _Float64Array | _DLPackProducer) -> DifferentiableEvaluation: ...
    def primal(self) -> DifferentiablePrimal: ...
    def jvp(self, tangent: Array | _Float64Array | _DLPackProducer) -> DifferentiableJvp: ...
    def vjp(self, cotangent: Array | _Float64Array | _DLPackProducer) -> DifferentiableVjp: ...

DifferentiableVjp

Section titled “DifferentiableVjp”

Accepted primary field and its reverse input cotangent.

Authority: crates/eqiora-python/src/differentiation.rs::PyDifferentiableVjp

python
@final
class DifferentiableVjp:
    @property
    def output(self) -> Array: ...
    @property
    def input_cotangent(self) -> Array: ...
    @property
    def evidence(self) -> DifferentiationEvidence: ...

DifferentiationEvidence

Section titled “DifferentiationEvidence”

Typed in-memory provenance for one differentiation occurrence.

Authority: crates/eqiora-python/src/differentiation.rs::PyDifferentiationEvidence

python
@final
class DifferentiationEvidence:
    @property
    def model_digest(self) -> str: ...
    @property
    def realization_digest(self) -> str: ...
    @property
    def input_ids(self) -> list[str]: ...
    @property
    def output_id(self) -> str: ...
    @property
    def mode(self) -> DifferentiationMode: ...
    @property
    def implementation(self) -> DerivativeImplementation: ...
    @property
    def linearization_state(self) -> LinearizationState: ...
    @property
    def state_system_fingerprint(self) -> str: ...
    @property
    def primal_residual_norm(self) -> float: ...
    @property
    def residual_tolerance(self) -> float: ...
    @property
    def primal_solve(self) -> LinearSolveSummary: ...
    @property
    def derivative_solve(self) -> LinearSolveSummary | None: ...

DifferentiationMode

Section titled “DifferentiationMode”

Primal, JVP, or VJP occurrence kind.

Authority: crates/eqiora-python/src/differentiation.rs::PyDifferentiationMode

python
@final
class DifferentiationMode:
    Primal: ClassVar[DifferentiationMode]
    Jvp: ClassVar[DifferentiationMode]
    Vjp: ClassVar[DifferentiationMode]
    def __eq__(self, other: object, /) -> bool: ...
    def __hash__(self) -> int: ...

Dimension

Section titled “Dimension”

SI base-dimension exponents in M, L, T, I, Θ, N, J order.

Authority: crates/eqiora-python/src/modeling.rs::PyDimension

python
@final
class Dimension:
    def __new__(cls, *, mass: int=0, length: int=0, time: int=0, current: int=0, temperature: int=0, amount: int=0, luminous_intensity: int=0) -> Self: ...
    @property
    def exponents(self) -> tuple[int, int, int, int, int, int, int]: ...
    def __eq__(self, other: object, /) -> bool: ...
    def __ne__(self, other: object, /) -> bool: ...

Domain

Section titled “Domain”

Immutable draft-local Cartesian volume or oriented boundary.

Authority: crates/eqiora-python/src/modeling.rs::PyDomain

python
@final
class Domain:
    @staticmethod
    def box(name: str, *bounds: tuple[float, float]) -> Domain: ...
    def boundary(self, name: str, *, axis: int, side: BoundarySide) -> Domain: ...
    @property
    def name(self) -> str: ...
    @property
    def bounds(self) -> list[tuple[float, float]] | None: ...
    @property
    def parent(self) -> Domain | None: ...
    @property
    def axis(self) -> int | None: ...
    @property
    def side(self) -> BoundarySide | None: ...
    def __eq__(self, other: object, /) -> bool: ...
    def __hash__(self) -> int: ...

EqioraError

Section titled “EqioraError”

Base failure for an Eqiora operation rejected with diagnostics.

Authority: crates/eqiora-python/src/error.rs::EqioraError

python
class EqioraError(Exception):
    category: str
    diagnostics: tuple[Diagnostic, ...]

ExecutionError

Section titled “ExecutionError”

Failure of an admitted execution.

Authority: crates/eqiora-python/src/error.rs::ExecutionError

python
class ExecutionError(EqioraError):
    ...

Expression

Section titled “Expression”

Immutable symbolic expression whose shape and support Rust infers.

Authority: crates/eqiora-python/src/modeling.rs::PyExpression

python
@final
class Expression:
    def __neg__(self) -> Expression: ...
    def __add__(self, right: _ExpressionLike, /) -> Expression: ...
    def __radd__(self, left: _ExpressionLike, /) -> Expression: ...
    def __sub__(self, right: _ExpressionLike, /) -> Expression: ...
    def __rsub__(self, left: _ExpressionLike, /) -> Expression: ...
    def __mul__(self, right: _ExpressionLike, /) -> Expression: ...
    def __rmul__(self, left: _ExpressionLike, /) -> Expression: ...
    def __truediv__(self, right: _ExpressionLike, /) -> Expression: ...
    def __rtruediv__(self, left: _ExpressionLike, /) -> Expression: ...
    def __bool__(self) -> bool: ...

Field

Section titled “Field”

Immutable scalar field declaration.

Authority: crates/eqiora-python/src/modeling.rs::PyField

python
@final
class Field:
    def __new__(cls, name: str, *, domain: Domain | None=None, representation: Representation | None=None, dimension: Dimension | None=None, initial: float=0.0) -> Self: ...
    @property
    def name(self) -> str: ...
    @property
    def dimension(self) -> Dimension: ...
    @property
    def initial(self) -> float: ...
    @property
    def domain(self) -> Domain | None: ...
    @property
    def representation(self) -> Representation | None: ...
    def __neg__(self) -> Expression: ...
    def __add__(self, right: _ExpressionLike, /) -> Expression: ...
    def __radd__(self, left: _ExpressionLike, /) -> Expression: ...
    def __sub__(self, right: _ExpressionLike, /) -> Expression: ...
    def __rsub__(self, left: _ExpressionLike, /) -> Expression: ...
    def __mul__(self, right: _ExpressionLike, /) -> Expression: ...
    def __rmul__(self, left: _ExpressionLike, /) -> Expression: ...
    def __truediv__(self, right: _ExpressionLike, /) -> Expression: ...
    def __rtruediv__(self, left: _ExpressionLike, /) -> Expression: ...
    def __bool__(self) -> bool: ...

FieldRef

Section titled “FieldRef”

Exact canonical field selected from one immutable model.

Authority: crates/eqiora-python/src/model.rs::PyModelFieldRef

python
@final
class FieldRef:
    @property
    def model_digest(self) -> str: ...
    @property
    def id(self) -> str: ...
    def __eq__(self, other: object, /) -> bool: ...
    def __hash__(self) -> int: ...

InternalError

Section titled “InternalError”

Internal failure that does not expose implementation details.

Authority: crates/eqiora-python/src/error.rs::InternalError

python
class InternalError(EqioraError):
    ...

LinearSolveSummary

Section titled “LinearSolveSummary”

Bounded projection of an independently accepted linear-solve report.

Authority: crates/eqiora-python/src/realization.rs::PyLinearSolveSummary

python
@final
class LinearSolveSummary:
    @property
    def backend(self) -> str: ...
    @property
    def adapter(self) -> str: ...
    @property
    def verification_adapter(self) -> str: ...
    @property
    def orientation(self) -> str: ...
    @property
    def algorithm(self) -> str: ...
    @property
    def preconditioner(self) -> str: ...
    @property
    def reduction(self) -> str: ...
    @property
    def relative_tolerance(self) -> float: ...
    @property
    def absolute_tolerance(self) -> float: ...
    @property
    def maximum_iterations(self) -> int: ...
    @property
    def reason(self) -> ConvergenceReason: ...
    @property
    def completed_iterations(self) -> int: ...
    @property
    def initial_residual_norm(self) -> float: ...
    @property
    def reported_residual_norm(self) -> float: ...
    @property
    def true_residual_norm(self) -> float: ...
    @property
    def residual_target(self) -> float: ...

LinearizationState

Section titled “LinearizationState”

Whether an accepted linearization was established or reused.

Authority: crates/eqiora-python/src/differentiation.rs::PyLinearizationState

python
@final
class LinearizationState:
    Established: ClassVar[LinearizationState]
    Reused: ClassVar[LinearizationState]
    def __eq__(self, other: object, /) -> bool: ...
    def __hash__(self) -> int: ...

Model

Section titled “Model”

Immutable canonical model artifact, admitted when semantically closed.

Authority: crates/eqiora-python/src/model.rs::PyModel

python
@final
class Model:
    @staticmethod
    def define(name: str, *declarations: _ModelDeclaration) -> Model: ...
    def to_json(self) -> bytes: ...
    def preview_value_edit(self, target: str, value: float) -> ValueEdit: ...
    def commit(self, edit: ValueEdit) -> Model: ...
    def parameter(self, selection: str) -> ParameterRef: ...
    def field(self, selection: str) -> FieldRef: ...
    def structurally_equivalent(self, other: Model) -> bool: ...
    @property
    def digest(self) -> str: ...
    @property
    def package_compilation_digest(self) -> str | None: ...
    @property
    def structural_fingerprint(self) -> StructuralSemanticFingerprint: ...
    @property
    def revision(self) -> Revision: ...
    @property
    def model_id(self) -> str: ...
    @property
    def field_ids(self) -> list[str]: ...
    @property
    def parameter_ids(self) -> list[str]: ...
    def __eq__(self, other: object, /) -> bool: ...
    def __hash__(self) -> int: ...

PackageConformancePackage

Section titled “PackageConformancePackage”

Identity fields for one package in a conformance report.

Authority: bindings/python/python/eqiora/init.py::check_package_conformance

python
class PackageConformancePackage(NamedTuple):
    name: str
    version: str
    semantic_digest: str
    source_digest: str

PackageConformanceReport

Section titled “PackageConformanceReport”

Structural-conformance report for one locked package closure.

Authority: bindings/python/python/eqiora/init.py::check_package_conformance

python
class PackageConformanceReport(NamedTuple):
    profile: str
    eqiora_version: str
    compiler: str
    compiler_version: str
    semantic_canonicalization_version: int
    source_bundle_version: int
    resolution_version: int
    root_package: PackageConformancePackage
    packages: tuple[PackageConformancePackage, ...]
    entry_model: str
    resolution_digest: str
    package_compilation_digest: str
    model_id: str
    model_revision: int
    model_digest: str
    deterministic_replay_agreement: bool

Parameter

Section titled “Parameter”

Immutable scalar parameter declaration.

Authority: crates/eqiora-python/src/modeling.rs::PyParameter

python
@final
class Parameter:
    def __new__(cls, name: str, *, value: float, dimension: Dimension | None=None) -> Self: ...
    @property
    def name(self) -> str: ...
    @property
    def dimension(self) -> Dimension: ...
    @property
    def value(self) -> float: ...
    def __neg__(self) -> Expression: ...
    def __add__(self, right: _ExpressionLike, /) -> Expression: ...
    def __radd__(self, left: _ExpressionLike, /) -> Expression: ...
    def __sub__(self, right: _ExpressionLike, /) -> Expression: ...
    def __rsub__(self, left: _ExpressionLike, /) -> Expression: ...
    def __mul__(self, right: _ExpressionLike, /) -> Expression: ...
    def __rmul__(self, left: _ExpressionLike, /) -> Expression: ...
    def __truediv__(self, right: _ExpressionLike, /) -> Expression: ...
    def __rtruediv__(self, left: _ExpressionLike, /) -> Expression: ...
    def __bool__(self) -> bool: ...

ParameterRef

Section titled “ParameterRef”

Exact canonical parameter selected from one immutable model.

Authority: crates/eqiora-python/src/model.rs::PyModelParameterRef

python
@final
class ParameterRef:
    @property
    def model_digest(self) -> str: ...
    @property
    def id(self) -> str: ...
    def __eq__(self, other: object, /) -> bool: ...
    def __hash__(self) -> int: ...

PhysicalDomain

Section titled “PhysicalDomain”

Immutable nominal scalar physical-domain declaration.

Authority: crates/eqiora-python/src/modeling.rs::PyPhysicalDomain

python
@final
class PhysicalDomain:
    def __new__(cls, name: str, *, across_dimension: Dimension, through_dimension: Dimension) -> Self: ...
    @property
    def name(self) -> str: ...
    @property
    def across_dimension(self) -> Dimension: ...
    @property
    def through_dimension(self) -> Dimension: ...

Realization

Section titled “Realization”

Exact model-bound capability-admitted portable realization.

Authority: crates/eqiora-python/src/realization.rs::PyRealization

python
@final
class Realization:
    @property
    def digest(self) -> str: ...
    @property
    def model_digest(self) -> str: ...
    @property
    def realization_revision(self) -> int: ...
    @property
    def method(self) -> ScalarEllipticMethod: ...
    @property
    def cells_per_axis(self) -> int: ...
    @property
    def workers(self) -> int: ...
    @property
    def cell_count(self) -> int: ...
    @property
    def field_value_count(self) -> int: ...
    @property
    def spatial_dimension(self) -> int: ...
    @property
    def field_logical_shape(self) -> tuple[int, ...]: ...
    @property
    def field_bounds(self) -> tuple[tuple[float, float], ...]: ...
    def to_json(self) -> bytes: ...
    def __eq__(self, other: object, /) -> bool: ...
    def __hash__(self) -> int: ...

Representation

Section titled “Representation”

Immutable continuum representation declaration.

Authority: crates/eqiora-python/src/modeling.rs::PyRepresentation

python
@final
class Representation:
    @staticmethod
    def continuum(name: str) -> Representation: ...
    @property
    def name(self) -> str: ...
    def __eq__(self, other: object, /) -> bool: ...
    def __hash__(self) -> int: ...

Relation

Section titled “Relation”

Immutable continuous implicit relation declaration.

Authority: crates/eqiora-python/src/modeling.rs::PyRelation

python
@final
class Relation:
    @overload
    def __new__(cls, name: str, *, domain: Domain | None=None, residual: _ExpressionLike, residuals: None=None) -> Self: ...
    @overload
    def __new__(cls, name: str, *, domain: Domain | None=None, residual: None=None, residuals: Sequence[_ExpressionLike]) -> Self: ...
    @property
    def name(self) -> str: ...
    @property
    def residual(self) -> Expression: ...
    @property
    def residuals(self) -> list[Expression]: ...
    @property
    def domain(self) -> Domain | None: ...

Result

Section titled “Result”

Accepted execution occurrence with typed output relationships.

Authority: crates/eqiora-python/src/result.rs::PyRunResult

python
@final
class Result:
    @property
    def model_id(self) -> str: ...
    @property
    def model_digest(self) -> str: ...
    @property
    def model_revision(self) -> int: ...
    @property
    def plan_key(self) -> str: ...
    @property
    def adapter(self) -> str: ...
    @property
    def adapter_version(self) -> str: ...
    @property
    def elapsed_seconds(self) -> float: ...
    @property
    def fields(self) -> list[Series]: ...
    @property
    def snapshots(self) -> tuple[trajectory.FieldSnapshot, ...]: ...
    def field(self, field: FieldRef, /) -> trajectory.FieldSnapshot: ...
    def mesh(self, field: FieldRef, /) -> meshing.Mesh: ...
    @property
    def trajectory(self) -> trajectory.Trajectory: ...
    def run_manifest(self) -> RunManifest: ...
    def __len__(self) -> int: ...
    def __getitem__(self, key: str, /) -> Series: ...

Revision

Section titled “Revision”

Exact identity of one immutable canonical model artifact.

Authority: crates/eqiora-python/src/model.rs::PyRevision

python
@final
class Revision:
    @property
    def model_id(self) -> str: ...
    @property
    def digest(self) -> str: ...
    @property
    def number(self) -> int: ...
    def __eq__(self, other: object, /) -> bool: ...
    def __hash__(self) -> int: ...

Run

Section titled “Run”

Awaitable owner of one native execution occurrence.

Authority: bindings/python/python/eqiora/init.py::Run

python
class Run(Generic[_RunResultT]):
    def __init__(self, native: Never) -> None: ...
    @property
    def status(self) -> RunStatus: ...
    @property
    def history(self) -> tuple[RunStatus, ...]: ...
    @property
    def progress(self) -> RunProgress | ScalarEllipticRunProgress | None: ...
    @property
    def cancellation(self) -> RunCancellation | ScalarEllipticRunCancellation | None: ...
    @property
    def done(self) -> bool: ...
    @property
    def model_id(self) -> str: ...
    @property
    def model_digest(self) -> str: ...
    @property
    def model_revision(self) -> int: ...
    @property
    def plan_key(self) -> str: ...
    @property
    def adapter(self) -> str: ...
    def cancel(self) -> bool: ...
    def result(self) -> _RunResultT: ...
    def __await__(self) -> Generator[Any, None, _RunResultT]: ...

RunManifest

Section titled “RunManifest”

Persisted exact run-v2 manifest linked to an accepted realization.

Authority: crates/eqiora-python/src/realization.rs::PyRunManifest

python
@final
class RunManifest:
    @staticmethod
    def from_json(data: bytes, *, realization: Realization) -> RunManifest: ...
    @property
    def digest(self) -> str: ...
    @property
    def model_digest(self) -> str: ...
    @property
    def realization_digest(self) -> str: ...
    @property
    def semantic_revision(self) -> int: ...
    @property
    def output_digests(self) -> list[str]: ...
    @property
    def adapter(self) -> str: ...
    @property
    def adapter_version(self) -> str: ...
    @property
    def solver_backend(self) -> str: ...
    @property
    def solver_backend_version(self) -> str: ...
    @property
    def workers(self) -> int: ...
    @property
    def reduction(self) -> str: ...
    def to_json(self) -> bytes: ...
    def __eq__(self, other: object, /) -> bool: ...
    def __hash__(self) -> int: ...

RunCancellation

Section titled “RunCancellation”

Exact accepted boundary where cooperative cancellation terminated.

Authority: crates/eqiora-python/src/execution/evidence.rs::PyRunCancellation

python
@final
class RunCancellation:
    @property
    def progress(self) -> RunProgress: ...
    @property
    def elapsed_seconds(self) -> float: ...
    @property
    def plan_key(self) -> str: ...

RunProgress

Section titled “RunProgress”

Last coalesced fully accepted semantic-execution boundary.

Authority: crates/eqiora-python/src/execution/evidence.rs::PyRunProgress

python
@final
class RunProgress:
    @property
    def model_time(self) -> float: ...
    @property
    def end_time(self) -> float: ...
    @property
    def accepted_steps(self) -> int: ...
    @property
    def maximum_steps(self) -> int: ...

RunStatus

Section titled “RunStatus”

Monotone public state of one native execution occurrence.

Authority: crates/eqiora-python/src/execution/evidence.rs::PyRunStatus

python
@final
class RunStatus:
    Created: ClassVar[RunStatus]
    Validating: ClassVar[RunStatus]
    Queued: ClassVar[RunStatus]
    Running: ClassVar[RunStatus]
    Cancelling: ClassVar[RunStatus]
    Cancelled: ClassVar[RunStatus]
    Completed: ClassVar[RunStatus]
    Failed: ClassVar[RunStatus]
    def __eq__(self, other: object, /) -> bool: ...
    def __hash__(self) -> int: ...

ScalarElliptic

Section titled “ScalarElliptic”

Unbound typed scalar-elliptic request, not realization identity.

Authority: crates/eqiora-python/src/realization.rs::PyScalarElliptic

python
@final
class ScalarElliptic:
    def __new__(cls, *, method: ScalarEllipticMethod, cells_per_axis: int, realization_revision: int=1) -> Self: ...
    @property
    def method(self) -> ScalarEllipticMethod: ...
    @property
    def cells_per_axis(self) -> int: ...
    @property
    def realization_revision(self) -> int: ...
    def __eq__(self, other: object, /) -> bool: ...
    def __hash__(self) -> int: ...

ScalarEllipticBalance

Section titled “ScalarEllipticBalance”

Accepted continuous scalar-elliptic balance evidence.

Authority: crates/eqiora-python/src/realization.rs::PyScalarEllipticBalance

python
@final
class ScalarEllipticBalance:
    @property
    def boundary_total(self) -> float: ...
    @property
    def integrated_source(self) -> float: ...
    @property
    def relative_imbalance(self) -> float: ...

ScalarEllipticMethod

Section titled “ScalarEllipticMethod”

Numerical family for one bounded scalar-elliptic request.

Authority: crates/eqiora-python/src/realization.rs::PyScalarEllipticMethod

python
@final
class ScalarEllipticMethod:
    FiniteElement: ClassVar[ScalarEllipticMethod]
    FiniteVolume: ClassVar[ScalarEllipticMethod]
    def __eq__(self, other: object, /) -> bool: ...
    def __hash__(self) -> int: ...

ScalarEllipticResult

Section titled “ScalarEllipticResult”

Accepted scalar-elliptic result with producer/verifier evidence.

Authority: crates/eqiora-python/src/realization.rs::PyScalarEllipticResult

python
@final
class ScalarEllipticResult:
    @property
    def realization(self) -> Realization: ...
    @property
    def run_manifest(self) -> RunManifest: ...
    @property
    def elapsed_seconds(self) -> float: ...
    @property
    def field(self) -> ScalarFieldSummary: ...
    @property
    def values(self) -> Array: ...
    @property
    def balance(self) -> ScalarEllipticBalance: ...
    @property
    def solve(self) -> LinearSolveSummary: ...
    @property
    def output_fingerprint(self) -> str: ...

ScalarEllipticRunCancellation

Section titled “ScalarEllipticRunCancellation”

Exact scalar-elliptic phase where cancellation terminated.

Authority: crates/eqiora-python/src/execution/evidence.rs::PyScalarEllipticRunCancellation

python
@final
class ScalarEllipticRunCancellation:
    @property
    def progress(self) -> ScalarEllipticRunProgress: ...
    @property
    def elapsed_seconds(self) -> float: ...
    @property
    def plan_key(self) -> str: ...

ScalarEllipticRunProgress

Section titled “ScalarEllipticRunProgress”

Last fully accepted scalar-elliptic application phase.

Authority: crates/eqiora-python/src/execution/evidence.rs::PyScalarEllipticRunProgress

python
@final
class ScalarEllipticRunProgress:
    PlanReplayed: ClassVar[ScalarEllipticRunProgress]
    SystemFinalized: ClassVar[ScalarEllipticRunProgress]
    SolutionAccepted: ClassVar[ScalarEllipticRunProgress]
    def __eq__(self, other: object, /) -> bool: ...
    def __hash__(self) -> int: ...

ScalarFieldLocation

Section titled “ScalarFieldLocation”

Vertex or cell-centre meaning of a scalar field summary.

Authority: crates/eqiora-python/src/realization.rs::PyScalarFieldLocation

python
@final
class ScalarFieldLocation:
    Vertex: ClassVar[ScalarFieldLocation]
    CellCenter: ClassVar[ScalarFieldLocation]
    def __eq__(self, other: object, /) -> bool: ...
    def __hash__(self) -> int: ...

ScalarFieldSummary

Section titled “ScalarFieldSummary”

Bounded accepted field summary; arrays remain on the data plane.

Authority: crates/eqiora-python/src/realization.rs::PyScalarFieldSummary

python
@final
class ScalarFieldSummary:
    @property
    def location(self) -> ScalarFieldLocation: ...
    @property
    def spatial_dimension(self) -> int: ...
    @property
    def logical_shape(self) -> tuple[int, ...]: ...
    @property
    def value_count(self) -> int: ...
    @property
    def minimum(self) -> float: ...
    @property
    def maximum(self) -> float: ...

Series

Section titled “Series”

Read-only field-local sampled series in SI units.

Authority: crates/eqiora-python/src/result.rs::PySeries

python
@final
class Series:
    @property
    def id(self) -> str: ...
    @property
    def name(self) -> str | None: ...
    @property
    def dimension(self) -> tuple[int, int, int, int, int, int, int]: ...
    @property
    def time(self) -> Array: ...
    @property
    def values(self) -> Array: ...
    def __len__(self) -> int: ...
    def __iter__(self) -> Iterator[tuple[float, float]]: ...

StructuralSemanticFingerprint

Section titled “StructuralSemanticFingerprint”

Alpha-normalized comparison evidence, not exact model identity.

Authority: crates/eqiora-python/src/model.rs::PyStructuralSemanticFingerprint

python
@final
class StructuralSemanticFingerprint:
    @property
    def generation(self) -> str: ...
    @property
    def digest(self) -> str: ...
    def __eq__(self, other: object, /) -> bool: ...
    def __hash__(self) -> int: ...

ValidationError

Section titled “ValidationError”

Failure caused by a model or request violating a typed contract.

Authority: crates/eqiora-python/src/error.rs::ValidationError

python
class ValidationError(EqioraError):
    ...

ValueEdit

Section titled “ValueEdit”

Immutable exact-base value edit prepared by the Rust facade.

Authority: crates/eqiora-python/src/model.rs::PyValueEdit

python
@final
class ValueEdit:
    @property
    def key(self) -> str: ...
    @property
    def base_digest(self) -> str: ...
    @property
    def base_revision(self) -> int: ...
    @property
    def target_id(self) -> str: ...
    def __eq__(self, other: object, /) -> bool: ...
    def __hash__(self) -> int: ...

across

Section titled “across”

Return the across variable of a scalar conserving port.

Authority: crates/eqiora-python/src/modeling.rs::across

python
def across(port: ConservingPort) -> Expression: ...

check_package_conformance

Section titled “check_package_conformance”

Check one exact locked package closure by deterministic replay.

Authority: crates/eqiora-python/src/package.rs::_check_package_conformance

python
def check_package_conformance(store_root: str | os.PathLike[str], resolution_bytes: bytes, *, entry_model: str, profile: str) -> PackageConformanceReport: ...

compile

Section titled “compile”

Compile one model through the canonical Rust pipeline.

Authority: crates/eqiora-python/src/lib.rs::compile

python
def compile(source: str, *, filename: str='<memory>') -> Model: ...

compile_package

Section titled “compile_package”

Compile one root-local model from a selected locked package store.

Authority: crates/eqiora-python/src/package.rs::compile_package

python
def compile_package(store_root: str | PathLike[str], resolution: bytes, *, entry_model: str) -> Model: ...

connect

Section titled “connect”

Build an anonymous conserving connection declaration.

Authority: crates/eqiora-python/src/modeling.rs::connect

python
def connect(*ports: ConservingPort) -> Connection: ...

derivative

Section titled “derivative”

Return the time derivative of a field.

Authority: crates/eqiora-python/src/modeling.rs::derivative

python
def derivative(field: Field) -> Expression: ...

div

Section titled “div”

Return the spatial divergence of a symbolic expression.

Authority: crates/eqiora-python/src/modeling.rs::div

python
def div(value: _ExpressionLike) -> Expression: ...

grad

Section titled “grad”

Return the spatial gradient of a symbolic expression.

Authority: crates/eqiora-python/src/modeling.rs::grad

python
def grad(value: _ExpressionLike) -> Expression: ...

preview_realization

Section titled “preview_realization”

Resolve a request before numerical allocation.

Authority: crates/eqiora-python/src/realization.rs::preview_realization

python
def preview_realization(model: Model, request: ScalarElliptic) -> Realization: ...

replay

Section titled “replay”

Replay one canonical artifact through the current model contract.

Authority: crates/eqiora-python/src/lib.rs::replay

python
def replay(data: bytes) -> Model: ...

run

Section titled “run”

Execute through the lifecycle returned by submit.

Authority: bindings/python/python/eqiora/init.py::run

python
@overload
def run(model: Model, *, end_time: float, max_step: float, realization: None=None) -> Result: ...


@overload
def run(model: Model, *, realization: Realization) -> ScalarEllipticResult: ...


@overload
def run(model: Model, *, plan: fluid.SteadyStokesPlan) -> Result: ...


@overload
def run(model: Model, *, plan: solid.LinearElasticityPlan) -> Result: ...


@overload
def run(model: Model, *, plan: fsi.FixedMeshMonolithicPlan) -> Result: ...

submit

Section titled “submit”

Submit one accepted temporal, spatial, or plan request shape.

Authority: bindings/python/python/eqiora/init.py::submit

python
@overload
def submit(model: Model, *, end_time: float, max_step: float, realization: None=None) -> Run[Result]: ...


@overload
def submit(model: Model, *, realization: Realization) -> Run[ScalarEllipticResult]: ...


@overload
def submit(model: Model, *, plan: fluid.SteadyStokesPlan) -> Run[Result]: ...


@overload
def submit(model: Model, *, plan: solid.LinearElasticityPlan) -> Run[Result]: ...


@overload
def submit(model: Model, *, plan: fsi.FixedMeshMonolithicPlan) -> Run[Result]: ...

through

Section titled “through”

Return the through variable of a scalar conserving port.

Authority: crates/eqiora-python/src/modeling.rs::through

python
def through(port: ConservingPort) -> Expression: ...

trace

Section titled “trace”

Return the boundary trace of a symbolic expression.

Authority: crates/eqiora-python/src/modeling.rs::trace

python
def trace(value: _ExpressionLike) -> Expression: ...

diff

Section titled “diff”

Module export. This spelling exposes the documented public module eqiora.diff.

Accepted implicit differentiation over exact Eqiora programs.

Authority: bindings/python/python/eqiora/diff.py

fluid

Section titled “fluid”

Module export. This spelling exposes the documented public module eqiora.fluid.

Narrow fluid applications composed by Eqiora’s shared native layer.

Authority: bindings/python/python/eqiora/fluid.py

fsi

Section titled “fsi”

Module export. This spelling exposes the documented public module eqiora.fsi.

Fixed-mesh monolithic FSI intent, plan, and typed evidence.

Authority: bindings/python/python/eqiora/fsi.py

geometry

Section titled “geometry”

Module export. This spelling exposes the documented public module eqiora.geometry.

Bounded exact geometry values owned by the native implementation.

Authority: bindings/python/python/eqiora/geometry.py

meshing

Section titled “meshing”

Module export. This spelling exposes the documented public module eqiora.meshing.

Immutable geometry-to-mesh planning owned by the native implementation.

Authority: bindings/python/python/eqiora/meshing.py

solid

Section titled “solid”

Module export. This spelling exposes the documented public module eqiora.solid.

Typed structural intents, plans, and scientific evidence.

Authority: bindings/python/python/eqiora/solid.py

trajectory

Section titled “trajectory”

Module export. This spelling exposes the documented public module eqiora.trajectory.

Read-only projections of accepted Eqiora spatial trajectories.

Authority: bindings/python/python/eqiora/trajectory.py