Installation

Installation (user)

GeoST is distributed via the Python package index (PyPi) and Conda-forge. In a Python >= 3.13 environment, install the latest stable release in your environment with either pip, Pixi or Conda:

pip install geost

pixi add geost

When using Conda, make sure to specify the conda-forge channel:

conda install -c conda-forge geost

Or when using miniforge, which uses the conda-forge channel by default:

conda install geost

Installation for developers

GeoST uses Pixi for package and workflow management.

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. Next open the Pixi shell by running:

pixi shell

Finally install the pre-commit hooks that enable automatic checks upon committing changes:

pre-commit install