Installation#

GeoST is purely written in Python but it requires Python 3.12 or higher. The package is distributed via the Python Package Index (Pypi). Installing it into any environment is as easy as:

pip install geost

Latest experimental version#

The latest or expirimental version can be installed via the GitHub repository of GeoST. Simply install the main branch by:

pip install git+https://github.pixicom/Deltares-research/geost.git

Installation for developers#

GeoST uses Pixi for package management and workflows.

With pixi installed, navigate to the folder of the cloned repository and run the following to install all GeoST dependencies and the package itself in editable mode:

pixi install

See the Pixi documentation for more information.