opm-core/README

74 lines
1.6 KiB
Plaintext
Raw Normal View History

2012-08-23 06:58:41 -05:00
Open Porous Media Core Library
2012-08-24 06:46:16 -05:00
==============================
These are release notes for opm-core.
2012-08-23 06:58:41 -05:00
CONTENT
2012-08-24 06:46:16 -05:00
-------
2012-08-23 06:58:41 -05:00
opm-core is the core library within OPM and contains the following
2012-08-24 06:46:16 -05:00
* Eclipse deck input and preprosessing
2012-08-23 06:58:41 -05:00
* Fluid properties (basic PVT models and rock properties)
2012-08-24 06:46:16 -05:00
* Grid handling (cornerpoint grids, unstructured grid interface)
* Linear Algebra (interface to different linear solvers)
* Pressure solvers (various discretization schemes, flow models)
* Simulators (some basic examples of simulators based on sequential splitting schemes)
* Transport solvers (various discretization schemes, flow models)
* Utilities (input and output processing, unit conversion)
2012-08-23 06:58:41 -05:00
* Wells (basic well handling)
2012-08-24 06:46:16 -05:00
LICENSE
-------
The library is distributed under the GNU General Public License,
version 3 or later (GPLv3+).
PLATFORMS
---------
The opm-core module is designed to run on Linux platforms. It is also
regularly run on Mac OS X. No efforts have been made to ensure that
the code will compile and run on windows platforms.
DOWNLOADING
-----------
2012-08-23 06:58:41 -05:00
git clone git://github.com/OPM/opm-core.git
2012-08-24 06:46:16 -05:00
BUILDING
--------
cd ../opm-core
autoreconf -i
2012-08-23 06:58:41 -05:00
./configure
make
sudo make install
DEPENDENCIES FOR DEBIAN BASED DISTRIBUTIONS
2012-08-24 06:46:16 -05:00
-------------------------------------------
(to be updated)
2012-08-23 06:58:41 -05:00
DEPENDENCIES FOR SUSE BASED DISTRIBUTIONS
2012-08-24 06:46:16 -05:00
-----------------------------------------
blas libblas3 lapack liblapack3 libboost libxml2 gcc automake autoconf
git doxygen umfpack
DOCUMENTATION
-------------
Efforts have been made to document the code with Doxygen.
In order to build the documentation, enter the command
$ doxygen
in the topmost directory.