Skip to content

Commit 2b11327

Browse files
authored
Update README.md
Added links to the manual and mailing list, updated some outdated items.
1 parent b6f23f6 commit 2b11327

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

README.md

+16-9
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,16 @@
33
CONTENT
44
-------
55

6-
opm-simulators contains simulator programs for porous media flow.
7-
The most important
8-
(and tested) part is the Flow reservoir simulator, which is a fully
9-
implicit black-oil simulator that also supports solvent and polymer
10-
options. It is built using automatic differentiation, using the local
11-
AD class Evaluation from opm-material.
6+
opm-simulators contains the OPM Flow reservoir simulator, which is a fully
7+
implicit black-oil simulator that also supports CO2 storage, H2 storage, thermal,
8+
solvent, and polymer options. It supports input and output in the common Eclipse formats,
9+
allowing easy integration in existing workflows.
10+
Its system assembly approach builds on automatic differentiation,
11+
using the local AD class Evaluation from opm-common. The linear solver subsystem is based on
12+
the dune-istl library.
13+
14+
For more information see https://opm-project.org, for the OPM manual see
15+
https://opm-project.org/?page_id=955
1216

1317
LICENSE
1418
-------
@@ -49,8 +53,8 @@ BUILDING
4953
See build instructions at http://opm-project.org/?page_id=36
5054

5155

52-
DOCUMENTATION
53-
-------------
56+
IN-CODE DOCUMENTATION
57+
---------------------
5458

5559
Efforts have been made to document the code with Doxygen.
5660
In order to build the documentation, enter the command
@@ -63,7 +67,10 @@ in the topmost directory.
6367
REPORTING ISSUES
6468
----------------
6569

66-
Issues can be reported in the Git issue tracker online at:
70+
The OPM mailing list can be used for questions and issue reporting,
71+
see https://opm-project.org/?page_id=358
72+
73+
Issues can also be reported in the Git issue tracker online at:
6774

6875
https://github.com/OPM/opm-simulators/issues
6976

0 commit comments

Comments
 (0)