|
10 | 10 |
|
11 | 11 | # Overview of OpenPNM
|
12 | 12 |
|
13 |
| -*OpenPNM* is a comprehensive framework for performing pore network simulations of porous materials. |
| 13 | +OpenPNM is a comprehensive framework for performing pore network simulations of porous materials. |
14 | 14 |
|
15 | 15 | ## More Information
|
16 | 16 |
|
17 |
| -For more details about the package can be found in the [on-line documentation](https://openpnm.org) |
| 17 | +For more details about the package can be found in the [online documentation](https://openpnm.org) |
18 | 18 |
|
19 | 19 | ## Installation and Requirements
|
20 | 20 |
|
21 |
| -### Preferred method |
22 |
| -The preferred way of installing OpenPNM is through [Anaconda Cloud](https://anaconda.org/conda-forge/openpnm) using: |
| 21 | +### [pip](https://pypi.org/project/openpnm/) |
| 22 | +OpenPNM can be installed using `pip` by running the following command in a terminal: |
23 | 23 |
|
24 |
| -``` |
25 |
| -conda install -c conda-forge openpnm |
| 24 | +```shell |
| 25 | +pip install openpnm |
26 | 26 | ```
|
27 | 27 |
|
28 |
| -### Alternative method |
29 |
| -OpenPNM can also be installed from the [Python Package Index](https://pypi.org/project/openpnm/) using: |
| 28 | +### [conda-forge](https://anaconda.org/conda-forge/openpnm) |
| 29 | +OpenPNM can also be installed from the [conda-forge](https://anaconda.org/conda-forge/openpnm) repository using: |
30 | 30 |
|
31 | 31 | ```
|
32 |
| -pip install openpnm |
| 32 | +conda install -c conda-forge openpnm |
33 | 33 | ```
|
34 | 34 |
|
35 |
| -However, we don't recommend installing using `pip` since `pypardiso`, which is a blazing fast direct solver, is not available for Windows users who use Python 3.7+. |
| 35 | +> [!WARNING] |
| 36 | +> For compatibility with ARM64 architecture, we removed `pypardiso` as a hard dependency. However, we still strongly recommend that non-macOS users (including users of older Macs with an Intel CPU) manually install `pypardiso` via `pip install pypardiso` or `conda install -c conda-forge pypardiso`, otherwise OpenPNM simulations will be very slow. |
36 | 37 |
|
37 | 38 | ### For developers
|
38 |
| -For developers who intend to change the source code or contribute to OpenPNM, the source code can be downloaded from [Github](https://github.com/pmeal/OpenPNM/) and installed by running: |
| 39 | +For developers who intend to change the source code or contribute to OpenPNM, the source code can be downloaded from [Github](https://github.com/PMEAL/OpenPNM/) and installed by running: |
39 | 40 |
|
40 | 41 | ```
|
41 | 42 | pip install -e 'path/to/downloaded/files'
|
42 | 43 | ```
|
43 | 44 |
|
44 |
| -The advantage to installing from the source code is that you can edit the files and have access to your changes each time you import *OpenPNM*. |
| 45 | +The advantage to installing from the source code is that you can edit the files and have access to your changes each time you import OpenPNM. |
45 | 46 |
|
46 |
| -OpenPNM requires the *Scipy Stack* (Numpy, Scipy, Matplotlib, etc), which is most conveniently obtained by installing the [Anaconda Distribution](https://conda.io/docs/user-guide/install/download.html). |
| 47 | +OpenPNM requires the Scipy Stack (Numpy, Scipy, Matplotlib, etc), which is most conveniently obtained by installing the [Anaconda Distribution](https://www.anaconda.com/download/). |
47 | 48 |
|
48 | 49 | ## Asking Questions and Getting Help
|
49 | 50 |
|
|
0 commit comments