@@ -7,30 +7,30 @@ Installation
7
7
OpenPNM depends heavily on the SciPy Stack. The best way to get a fully
8
8
functional environment is the `Anaconda
9
9
distribution <https://www.anaconda.com/products/individual#Downloads> `__.
10
- Be sure to get the Python 3.7 + version.
10
+ Be sure to get the Python 3.9 + version.
11
11
12
- Once you've installed * Anaconda * you can then install ``openpnm ``. It is
12
+ Once you've installed Anaconda you can then install ``openpnm ``. It is
13
13
available on `conda-forge <https://anaconda.org/conda-forge/openpnm >`__
14
- and can be installed by typing the following at the * conda * prompt::
14
+ and can be installed by typing the following at the `` conda `` prompt::
15
15
16
- $ conda install -c conda-forge openpnm
16
+ conda install -c conda-forge openpnm
17
17
18
18
It's possible to use ``pip install openpnm ``, but this will not result
19
- in a full installation and some features won't work (e.g., outputing to
20
- paraview ).
19
+ in a full installation and some features won't work (e.g., outputting to
20
+ ParaView ).
21
21
22
22
Installing the dev version
23
23
##########################
24
24
We frequently publish new releases every couple of months, but if you
25
- still want to use the latest features available on the `dev ` branch,
25
+ still want to use the latest features available on the `` dev ` ` branch,
26
26
(but not yet officially released), you have two options:
27
27
28
28
The easy way
29
29
------------
30
30
If you're looking for an easy way to install the development version of
31
31
``openpnm `` and use the latest features, you can install it using::
32
32
33
- $ pip install git+https://github.com/PMEAL/OpenPNM.git@dev
33
+ pip install git+https://github.com/PMEAL/OpenPNM.git@dev
34
34
35
35
.. warning ::
36
36
This approach is not recommended if you are a OpenPNM contributor or
@@ -48,40 +48,46 @@ Open up the terminal/cmd and ``cd`` to the directory you want to clone ``openpnm
48
48
49
49
Clone the repo somewhere in your disk using::
50
50
51
- $ git clone https://github.com/PMEAL/OpenPNM
51
+ git clone https://github.com/PMEAL/OpenPNM
52
52
53
53
``cd `` to the root folder of ``openpnm ``::
54
54
55
- $ cd OpenPNM
55
+ cd OpenPNM
56
56
57
- Install ``openpnm `` dependencies::
57
+ Install ``openpnm `` dependencies, either through `` conda `` ::
58
58
59
- $ conda install --file requirements/conda.txt -c conda-forge --override-channels
59
+ conda install --file requirements/conda.txt -c conda-forge
60
+
61
+ or through ``pip `` (as a last resort, since ``conda `` and ``pip `` are not very compatible)::
62
+
63
+ pip install -r requirements.txt
60
64
61
65
Install ``openpnm `` in "editable" mode::
62
66
63
- $ pip install --no-deps -e .
67
+ pip install -e .
64
68
65
69
Voila! You can now use the latest features available on the ``dev `` branch. To
66
70
keep your "local" ``openpnm `` installation up to date, every now and then, ``cd ``
67
71
to the root folder of ``openpnm `` and pull the latest changes::
68
72
69
- $ git pull
73
+ git pull
74
+
75
+ Of course, it'll be much easier if you use a GUI for ``git `` (e.g., GitFork, GitKraken, etc.).
70
76
71
77
.. warning ::
72
78
For the development version of ``openpnm `` to work, you need to first remove
73
79
the ``openpnm `` that you've previously installed using ``pip `` (via
74
80
``pip uninstall openpnm ``) or ``conda `` (via ``conda remove openpnm ``).
75
81
76
82
Where's my ``conda `` prompt?
77
- ###################################
83
+ ############################
78
84
All the commands in this page need to be typed in the ``conda `` prompt.
79
85
80
86
Windows
81
87
-------
82
88
On Windows you should have a shortcut to the "Anaconda prompt" in the
83
89
Anaconda program group in the start menu. This will open a Windows
84
- command console with access to the Python features added by * conda * ,
90
+ command console with access to the Python features added by `` conda `` ,
85
91
such as installing things via ``conda ``.
86
92
87
93
Mac and Linux
0 commit comments