README.md 1.71 KB
Newer Older
Lars Bilke's avatar
Lars Bilke committed
1
OpenGeoSys 6
2
============
Lars Bilke's avatar
Lars Bilke committed
3

Lars Bilke's avatar
Lars Bilke committed
4
[![Modified BSD License](http://img.shields.io/badge/license-BSD-blue.svg?style=flat-square)](https://gitlab.opengeosys.org/ogs/ogs/-/blob/master/LICENSE.txt)
Lars Bilke's avatar
Lars Bilke committed
5
[![DOI](https://zenodo.org/badge/1701384.svg)](https://zenodo.org/badge/latestdoi/1701384)
Lars Bilke's avatar
Lars Bilke committed
6

7
[OpenGeoSys][ogs] (OGS) is a scientific open source project for the development of
Lars Bilke's avatar
Lars Bilke committed
8
9
10
11
12
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
13
sequestration, geothermal energy, water resources management, hydrology and
14
waste deposition. OGS is comprised of the THMC-simulator (simply referred to as
15
*OGS*) and a visualization tool (*Data Explorer*). OGS is developed by the
16
17
18
19
[OpenGeoSys Community][ogs].

## Software development ##

20
- Good starting point for users as well as for developers is the [documentation][documentation]
Lars Bilke's avatar
Lars Bilke committed
21
- Check your code against our [styleguide](http://ufz.github.io/styleguide/cppguide.xml)
22
- Have a look at the [source code documentation for the current master-branch build][docs-master] or [for the latest release][docs-release]
23
24

## License ##
Lars Bilke's avatar
Lars Bilke committed
25

26
27
OpenGeoSys is distributed under the Modified BSD License. See the
[LICENSE.txt][license-source] for the license text.
Lars Bilke's avatar
Lars Bilke committed
28

Lars Bilke's avatar
Lars Bilke committed
29
[ogs]: https://www.opengeosys.org
Lars Bilke's avatar
Lars Bilke committed
30
[documentation]: https://www.opengeosys.org/docs/
31
[docs-master]: https://doxygen.opengeosys.org/
Lars Bilke's avatar
Lars Bilke committed
32
[docs-release]: https://doxygen.opengeosys.org/v6.4.0
Lars Bilke's avatar
Lars Bilke committed
33
[license-source]: https://github.com/ufz/ogs/blob/master/LICENSE.txt