forked from PMEAL/OpenPNM
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.txt
88 lines (53 loc) · 2.15 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
OpenPNM
=======
.. contents::
What is OpenPNM?
--------------
OpenPNM is open-source framework for conducting pore network modeling
simulations of multiphase transport in porous materials. It includes
modules for generating various common network topologies, pore and
throat geometry models, pore scale physics models, and fluid property
estimation. It also contains a large set of algorithms for running various
simulations such drainage curves, gas diffusion, permeability, and more.
OpenPNM is written in Python making extensive use of Scipy. Python is a very
flexible object oriented programming language that will be familiar to those
with experience using Matlab. OpenPNM takes advantages of the OOP paradigm
to structure the framework, but we stress that it is coded by engineers
without significant prior knowledge of object-oriented coding. Our goal
is to help other scientists and engineers harness the power and intuitive
pore network modeling approach, so if you are interested in this package,
please contact us through Github, or email one of the developer directly.
Installation
------------
.. code-block:: python
pip install openpnm
Documentation
-------------
OpenPNM documentation is available on the web:
https://openpnm.org
Web sites
---------
The user's site is:
https://openpnm.org
Mailing Lists
-------------
Please see the developer's discussion on GitHub:
https://github.com/PMEAL/OpenPNM/issues
Latest source code
------------------
The latest development version of OpenPNM sources are always available at:
https://github.com/PMEAL/OpenPNM
They can be downloaded as a zip file or using the Git client.
Bug reports
-----------
To search for bugs or report them, please use the OpenPNM Bug Tracker at:
https://github.com/PMEAL/OpenPNM/issues
Developer information
---------------------
If you would like to take part in OpenPNM development, please join the discussion on Github.
We are a small group and can guide you directly.
License information
-------------------
See the file ``LICENSE.txt`` for information on the history of this
software, terms & conditions for usage, and a DISCLAIMER OF ALL
WARRANTIES.