User Guide#

This guide gives an overview over the ogstools package. It explains important features, especially the usage of shipped command-line tools, and should give new users a good start with this package.

Getting Started#


It is a good practice to create a Python virtual environment in which your Python packages will get installed. Create a virtual environment and activate it:

python -m venv .venv
source .venv/bin/activate
python -m venv .venv

# The following may need to be run once. Please check the docs for its consequences:
Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope CurrentUser



Make sure to activate the virtual environment in every new shell session!

The latest release of ogstools can be installed from PyPI using pip:

pip install ogstools

Install development version

You can also install the latest development version with pip (requires also git):

pip install git+

First steps#

See the following tool descriptions: