Merge pull request #2466 from atgeirr/update-readme

Remove obsolete information from the README
This commit is contained in:
Atgeirr Flø Rasmussen 2020-03-13 11:24:51 +01:00 committed by GitHub
commit 0c3cacf4da
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -3,10 +3,8 @@
CONTENT CONTENT
------- -------
opm-simulators contains simulator programs for porous media flow. It opm-simulators contains simulator programs for porous media flow.
also contains a small library for automatic differentiation The most important
built on the Eigen linear algebra package which is used by many of the
simulators to handle the building of Jacobians. The most important
(and tested) part is the Flow reservoir simulator, which is a fully (and tested) part is the Flow reservoir simulator, which is a fully
implicit black-oil simulator that also supports solvent and polymer implicit black-oil simulator that also supports solvent and polymer
options. It is built using automatic differentiation, using the local options. It is built using automatic differentiation, using the local
@ -32,8 +30,8 @@ REQUIREMENTS
opm-simulators requires several other OPM modules, see opm-simulators requires several other OPM modules, see
http://opm-project.org/?page_id=274. In addition, opm-simulators http://opm-project.org/?page_id=274. In addition, opm-simulators
requires the Dune module dune-istl and Eigen, version 3.1 (has not been requires Dune and some other software to be available, for details
tested with later versions). see https://opm-project.org/?page_id=239.
DOWNLOADING DOWNLOADING
@ -59,8 +57,7 @@ In order to build the documentation, enter the command
make doc make doc
in the topmost directory. The class AutoDiffBlock is the most in the topmost directory.
important and most well-documented.
REPORTING ISSUES REPORTING ISSUES