LithoVox-Stability

A stripped-down version of GEOLib that only supports the Deltares D-Stability .stix format, plus:

• platform independent execution of the D-Stability console (Windows .exe and Linux/macOS via dotnet <console>.dll),
• migration of old .stix files with D-Stability Migration Console,
• an optional FastAPI server to run calculations through HTTP.

Installation

pip install lithovox-stability            # read, edit and write .stix files
pip install "lithovox-stability[plot]"    # + model.plot() (matplotlib)
pip install "lithovox-stability[server]"  # + the API server

Connecting to D-Stability

The D-Stability executables are not part of this package. Install D-Stability yourself and tell lithovox-stability where it is. Settings are read from environment variables or a lithovox_stability.env file in the working directory (see lithovox_stability.env.example). There is no auto-detection.

On Windows the .exe is started directly. On Linux/macOS the .dll is started with the .NET 8 runtime (dotnet "D-Stability Console.dll"), so install that runtime as well.

Reading and writing .stix files does not need D-Stability at all.

Usage

from lithovox_stability import DStabilityModel

# Read an existing .stix file
model = DStabilityModel.from_stix("input.stix")

# Inspect or edit the model
print(model.output)                       # results, if present
model.add_scenario("New scenario")        # only through the model API!
model.serialize("edited.stix")

# Run D-Stability (writes the results back into the .stix file)
model.execute()

Files created with an old D-Stability version (with e.g. ShearStrengthModelTypeAbovePhreaticLevel: CPhi) must be migrated first:

migrated = DStabilityModel.convert_legacy_file("old.stix", "new.stix")
model = DStabilityModel.from_stix(migrated)

API server

pip install "lithovox-stability[server]"
uvicorn lithovox_stability.service.main:app --host 0.0.0.0 --port 8000

curl -u test:test -F "file=@input.stix" -o result.stix http://localhost:8000/calculate

Tests

pip install -e ".[test]"
pytest

The tests use tests/data/test.stix. Tests marked console run D-Stability and are skipped unless DSTABILITY_FOLDER or DSTABILITY_CONSOLE_PATH points to a working installation, for example:

DSTABILITY_FOLDER=/path/to/dstability pytest