Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
FEM
 
 
 
 
GCC
 
 
GEO
 
 
MSH
 
 
 
 
 
 
OGS
 
 
 
 
UTL
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Tag BSD License (modified) Travis

OGS-5

Quickstart option 1: binary download

  • Go to the GitHub release page
  • Download the appropriate archive (*.zip for Windows, *.tar.gz for Linux, *.dmg for macOS) and unpack it
  • You will find the ogs-binary inside the bin-folder
  • Optional: Download and unpack the Data Explorer for OGS-5 too
  • Download and unpack benchmark files

Quickstart option 2: build from source

Prerequisites

  • Install a compiler
    • Win: Download and install Visual Studio Community 2017, during installation select the workload Desktop Development with C++, uncheck everything else
    • Linux: Install the following packages: make and build-essential
    • macOS: Install Xcode from the AppStore and run the following in the command line: xcode-select --install
  • Install Git
  • Install CMake

Source code

Get the source code either by downloading as a zip-file or with Git:

git clone https://github.com/ufz/ogs5.git

Build

Then set-up a build directory, configure your build and compile the code:

cd [source-directory]
mkdir build
cd build
cmake .. -DCMAKE_BUILD_TYPE=Release # Configures your build
cmake --build . --config Release    # Compiles the code

Further info

Quickstart: Run an OGS benchmark

Open a command prompt and run the following:

cd [benchmark-directory] # e.g. ogs5-benchmarks-master/H/Theis/GWF_Theis_2D
[path-to-ogs-exe-folder]/ogs [benchmark name] # e.g. ../../build/bin/ogs GWF_Theis_2d

Contributing: Using Git and GitHub

To implement new features, every developer

  1. forks this repository to have their own repo
  2. creates a branch from master and implement their stuff
  3. pushes the local branch to its GitHub repository
  4. makes a pull request from its GitHub repository to the master branch in the ufz/ogs5 repository