All docs
lsdtools.groundwater reference
Generated public SDK reference for lsdtools.groundwater.
SDK distribution 1.0.0; API contract 1.0; generator 1.0.0.
Product source digest: 4ea39055732e8883c03ccfecf12af6ccebd2041a12ce1b843e4a769e200f5ef9.
Generated from declared public exports and source syntax. Signatures and annotations are declaration spellings; decorators, factories and annotations are never executed. Class members below are declared members; base classes remain explicit. Source docstrings describe their owning implementation; they do not grant app permissions.
Lazy public facade for LSD saturated-groundwater execution.
Importing this module does not import NumPy, initialize CUDA, or import the
scientific runtime. First-party and Store packages exchange versioned,
JSON-safe documents through this boundary instead of importing
``lsd_groundwater`` directly.
lsdtools.groundwater.GroundwaterServiceUnavailable#
Kind: class. Source: sdk/src/lsdtools/groundwater.py:19.
GroundwaterServiceUnavailable(self, detail: str | None=None) -> None
Source docstring:
The selected Desktop does not provide a compatible runtime.
Declared bases: RuntimeError.
lsdtools.groundwater.GroundwaterServiceUnavailable.__init__#
Kind: method. Source: sdk/src/lsdtools/groundwater.py:22.
__init__(self, detail: str | None=None) -> None
detail: str | None
self: (unannotated)
lsdtools.groundwater.assess_compatibility#
Kind: function. Source: sdk/src/lsdtools/groundwater.py:86.
assess_compatibility(model: Mapping[str, object], execution: Mapping[str, object]) -> dict[str, object]
execution: Mapping[str, object]
model: Mapping[str, object]
Source docstring:
Return exact eligibility/refusal facts for one execution profile.
lsdtools.groundwater.capabilities#
Kind: function. Source: sdk/src/lsdtools/groundwater.py:58.
capabilities() -> dict[str, object]
Source docstring:
Return installed capabilities; an absent runtime is reported as data.
lsdtools.groundwater.run_steady#
Kind: function. Source: sdk/src/lsdtools/groundwater.py:101.
run_steady(model: Mapping[str, object], execution: Mapping[str, object]) -> dict[str, object]
execution: Mapping[str, object]
model: Mapping[str, object]
Source docstring:
Execute one admitted steady model without backend fallback.
lsdtools.groundwater.validate_model#
Kind: function. Source: sdk/src/lsdtools/groundwater.py:73.
validate_model(model: Mapping[str, object]) -> dict[str, object]
model: Mapping[str, object]
Source docstring:
Validate one backend-neutral physical model document.