Installing OGR Slip2D

OGR Slip2D is a pre-release and is still in active development. There are no signed installers yet, so for now you install it from its public source code, which takes a few minutes with Python.

Available now

From source

Version 0.1.235, the same code the tests run on.

Planned

Installers

Signed installers for Windows, macOS and Linux. They are the next item on the roadmap.

§ 01 — Install

Install from source

You need Python 3.11 or newer and Git. pip installs all the dependencies (NumPy, SciPy, Shapely, PySide6 and the rest) into a separate virtual environment.

In PowerShell or the command prompt:

git clone https://github.com/samuelsl27/OGR-Slip2D.git
cd OGR-Slip2D
python -m venv .venv
.venv\Scripts\activate
pip install -e .
ogr-slip2d

In Terminal:

git clone https://github.com/samuelsl27/OGR-Slip2D.git
cd OGR-Slip2D
python3 -m venv .venv
source .venv/bin/activate
pip install -e .
ogr-slip2d

In a terminal:

git clone https://github.com/samuelsl27/OGR-Slip2D.git
cd OGR-Slip2D
python3 -m venv .venv
source .venv/bin/activate
pip install -e .
ogr-slip2d

If the system cannot find the ogr-slip2d command, python -m ogr_gui starts the same program. It opens with an empty project; to try it out, File → Load Demo Slope loads a sample model.

§ 02 — What you get

The package and its three commands

The package is called ogr-slip2d. It installs the desktop program and a command-line interface, plus the server for AI agents if you add the [mcp] extra.

Command	What it starts	Learn more
`ogr-slip2d`	The desktop program (modeller, interpretation, Python terminal)	The interface
`ogr-slip2d-cli`	Command-line interface: inspect and compute `.ogr` projects	CLI reference
`ogr-slip2d-mcp`	MCP server for AI agents (needs `pip install -e ".[mcp]"`)	Connect an agent

Update

Updating an installation

From the repository folder, run git pull and then pip install -e . again, so that any new dependencies are installed.

Extras

Optional components

[mcp] adds the MCP server and [dev] the development tools. Neither is needed to run the program.

Changes

Version history

Each version has a changelog that records what was found during its development as well as what was written.

Changelog on GitHub ↗

§ 03 — Before you use it

About this pre-release

OGR Slip2D is research software and is still in active development. Its methods are validated against published cases and its test suite runs thousands of tests, but the program comes with no warranty of any kind. Its results must be checked against independent calculations before anything is based on them, and responsibility for a project lies with the engineer who signs it.

If you find an error, or know the factor of safety of a slope, please open an issue. Validation cases are the contribution that helps us most.

Quick start →Verification