Skip to content
Snippets Groups Projects
README.md 2.28 KiB
Newer Older
Lars Bilke's avatar
Lars Bilke committed
OpenGeoSys 6
============
Lars Bilke's avatar
Lars Bilke committed

[![Tag](https://img.shields.io/github/tag/ufz/ogs.svg?style=flat-square)](https://github.com/ufz/ogs/releases)
[![BSD License (modified)](http://img.shields.io/badge/license-BSD-blue.svg?style=flat-square)](https://github.com/ufz/ogs/blob/master/LICENSE.txt)
[![Travis](https://img.shields.io/travis/ufz/ogs.svg?style=flat-square)](https://travis-ci.org/ufz/ogs)
Lars Bilke's avatar
Lars Bilke committed
[![DOI](https://zenodo.org/badge/4228/ufz/ogs.svg)](https://zenodo.org/badge/latestdoi/4228/ufz/ogs)
[OpenGeoSys][ogs] (OGS) is a scientific open source project for the development of
Lars Bilke's avatar
Lars Bilke committed
numerical methods for the simulation of thermo-hydro-mechanical-chemical
(THMC) processes in porous and fractured media. OGS is implemented in C++, it
is object-oriented with an focus on the numerical solution of coupled multi-field
problems (multi-physics). Parallel versions of OGS are available relying on
both MPI and OpenMP concepts. Application areas of OGS are currently CO2
Lars Bilke's avatar
Lars Bilke committed
sequestration, geothermal energy, water resources management, hydrology and
waste deposition. OGS is comprised of the THMC-simulator (simply referred to as
*OGS*) and a visualization tool (*Data Explorer*). OGS is developed by the
[OpenGeoSys Community][ogs].

## Current status ##

Lars Bilke's avatar
Lars Bilke committed
It has to be noticed that the current OGS-6 version is under very heavy development
and [vivid discussion](https://github.com/ufz/ogs/issues), and does not implement all
functionality from OGS-5.
## Software development ##

- To get started checkout the [developer guide][devguide]
Lars Bilke's avatar
Lars Bilke committed
- Check your code against our [styleguide](http://ufz.github.io/styleguide/cppguide.xml)
- Have a look at the [source code documentation][docs]
- For the actual build status see the [Jenkins-CI server][jenkins-ci]
Lars Bilke's avatar
Lars Bilke committed
- Actual Travis build status: [![Build Status](https://travis-ci.org/ufz/ogs.png)](https://travis-ci.org/ufz/ogs)
Lars Bilke's avatar
Lars Bilke committed

OpenGeoSys is distributed under a Modified BSD License which encourages users to
attribute the work of the OpenGeoSys Community especially in scientific
publications. See the [LICENSE.txt][license-source] for the license text.
Lars Bilke's avatar
Lars Bilke committed

Lars Bilke's avatar
Lars Bilke committed
[ogs]: http://www.opengeosys.org
Lars Bilke's avatar
Lars Bilke committed
[devguide]: http://docs.opengeosys.org/docs/devguide
[jenkins-ci]: https://svn.ufz.de:8443/job/OGS-6/
[docs]: http://doxygen.opengeosys.org
[license-source]: https://github.com/ufz/ogs/blob/master/LICENSE.txt