The minimum prerequisites to build OGS are:
As we use lots of features of the C++11-standard we support Visual Studio 2015 and up. Therefore you will need at least Windows 7 (64-bit recommended). It is perfectly fine to use the free Community Edition of Visual Studio.
Desktop Development with C++
If you have a recent linux distribution you should also have a recent gcc. Please check that you have at least gcc 6.2:
Please install Xcode from the App Store. Then please run the following command in the terminal to install the command line tools:
Open Xcode one time to install some other Xcode stuff.
Now also install the Homebrew package manager:
$ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
$ brew doctor
The Homebrew package manager is needed for installing other libraries and packages. It is just like a linux package manager.
Git is a powerful and distributed version control system. OGS source code is hosted on GitHub. See the developer guide page on Code Reviews for more info on how OGS uses GitHub for collaborative development.
Download and install git from the git homepage. The default installer options are fine. This install a new command line called Git Bash which should be used for all git operations.
Let Git know who you are:
$ git config --global user.name "Your Name Here"
$ git config --global user.email "your_email@example.com"
In some corporate environments you may have to use a proxy server. In this case tell git about it:
Please check if Git is already installed:
Otherwise please install Git with your favorite package manager:
Let Git know who you are:
$ git config --global user.name "Your Name Here"
$ git config --global user.email "your_email@example.com"
Optionally enable password storing when interacting with a remote server:
In some corporate environments you may have to use a proxy server. In this case tell git about it:
Install Git with Homebrew:
Let Git know who you are:
$ git config --global user.name "Your Name Here"
$ git config --global user.email "your_email@example.com"
The graphical GitHub client is also maybe worth a look.
In some corporate environments you may have to use a proxy server. In this case tell git about it:
Git LFS (large file storage) is a git extension dealing with large binary files such as images and is used for the documentation. You don’t need to worry about anything but you need to install the extension as it is not a part of standard git.
git lfs install
Install via PackageCloud:
Install with Homebrew:
If you do not have rights to install a system package (e.g. on cluster systems) you can download a precompiled git-lfs
executable. Simply put it into your PATH
and everything should work (remember to run git lfs install
once!). See also: https://github.com/git-lfs/git-lfs/wiki/Installation#other
Install CMake with your favourite package manager (the two graphical user interfaces are optional):
Install CMake with Homebrew:
pip
enabled (you may uncheck Documentation, tcl/tk, Python test suite)Install Python 3 and pip:
Install Python 3 with Homebrew:
The Conan package manager helps to install all required libraries in a convenient way on every platform. If you prefer you can also install libraries manually instead.
Install Conan with Python’s pip:
Check on a newly opened command line if Conan was installed successfully:
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.54.0. Last revision: February 22, 2019
Commit: [web] Unified Python and Conan install instructions. 54b5b2a7c
| Edit this page on