Introduction

Installation

Download the latest release of OpenGeoSys from the Releases-page. Be sure to pick the correct file for your operating system.

OGS itself is a simple executable file so you can put it anywhere you like. For convenience you may put into a location which is in your PATH-environment variable which allows you to start the executable without specifying its full file path.

Alternative: Install via pip

You can also install ogs via Python’s pip-tool:

pip install ogs

If you install into an activated virtual environment then ogs and its tools are automatically also in the PATH. Otherwise pip will print instructions which directory needs to be added to the PATH.

Install via Python’s pip-tool:

pip install ogs

You may want to set up and activate a virtual environment before.

You could also use pipx to install into an isolated environment.

See Linux tab!

Limitations of the pip-based installation

  • Serial configuration only! For PETSc-support please use a Singularity container.
  • No embedded Python interpreter, i.e. no Python boundary conditions!
  • A Python (3.8 - 3.11) installation with pip is required.

Download benchmarks

You can download the latest benchmark files from GitLab:

  • On our OGS repository on GitLab browse to the Tests/Data-folder
  • Browse to the process subfolder you are interested in, e.g. Elliptic (1.)
  • Find the Downloads-dropdown (2.)
  • Choose an appropriate format under Download this directory (3.)
  • Uncompress the downloaded file

See the Benchmarks section for more information on the benchmarks.

Instructions for downloading benchmarks

Running

OGS is a command line application and requires the path to a .prj-file as an argument.

To run it open a new command line shell (called cmd.exe). Now simply type ogs (if the executable is in your PATH-environment variable) or specify its full path (e.g.: C:\Users\MyUserName\Downloads\ogs.exe) and hit ENTER.

OGS prints out its usage instructions:

PARSE ERROR:
             Required argument missing: project-file

Brief USAGE:
   ogs  [--] [--version] [-h] <PROJECT FILE>

For complete USAGE and HELP type:
   ogs --help

You can see that there is the project-file missing.

Then simply supply the path to a project file as an argument to the OGS executable:

ogs .\Path\to\BenchmarkName.prj

To run it open a new command line shell (Terminal). Now simply type ogs (if the executable is in your PATH-environment variable) or specify its full path (e.g.: ./path/to/ogs) and hit ENTER.

OGS prints out its usage instructions:

PARSE ERROR:
             Required argument missing: project-file

Brief USAGE:
   ogs  [--] [--version] [-h] <PROJECT FILE>

For complete USAGE and HELP type:
   ogs --help

You can see that there is the project-file missing.

Then simply supply the path to a project file as an argument to the OGS executable:

ogs ./path/to/BenchmarkName.prj

See Linux tab!


This article was written by Lars Bilke. If you are missing something or you find an error please let us know.
Generated with Hugo 0.101.0 in CI job 262272 | Last revision: October 24, 2022
Commit: [web] Update docs on notebook testing and web conversion. 1cb932f  | Edit this page on