Skip to content

Commit 29450d7

Browse files
committed
Update installation instructions
1 parent 23ee7dc commit 29450d7

File tree

1 file changed

+22
-16
lines changed

1 file changed

+22
-16
lines changed

docs/installation.rst

+22-16
Original file line numberDiff line numberDiff line change
@@ -7,30 +7,30 @@ Installation
77
OpenPNM depends heavily on the SciPy Stack. The best way to get a fully
88
functional environment is the `Anaconda
99
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.
1111

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
1313
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::
1515

16-
$ conda install -c conda-forge openpnm
16+
conda install -c conda-forge openpnm
1717

1818
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).
2121

2222
Installing the dev version
2323
##########################
2424
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,
2626
(but not yet officially released), you have two options:
2727

2828
The easy way
2929
------------
3030
If you're looking for an easy way to install the development version of
3131
``openpnm`` and use the latest features, you can install it using::
3232

33-
$ pip install git+https://github.com/PMEAL/OpenPNM.git@dev
33+
pip install git+https://github.com/PMEAL/OpenPNM.git@dev
3434

3535
.. warning::
3636
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
4848

4949
Clone the repo somewhere in your disk using::
5050

51-
$ git clone https://github.com/PMEAL/OpenPNM
51+
git clone https://github.com/PMEAL/OpenPNM
5252

5353
``cd`` to the root folder of ``openpnm``::
5454

55-
$ cd OpenPNM
55+
cd OpenPNM
5656

57-
Install ``openpnm`` dependencies::
57+
Install ``openpnm`` dependencies, either through ``conda``::
5858

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
6064

6165
Install ``openpnm`` in "editable" mode::
6266

63-
$ pip install --no-deps -e .
67+
pip install -e .
6468

6569
Voila! You can now use the latest features available on the ``dev`` branch. To
6670
keep your "local" ``openpnm`` installation up to date, every now and then, ``cd``
6771
to the root folder of ``openpnm`` and pull the latest changes::
6872

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.).
7076

7177
.. warning::
7278
For the development version of ``openpnm`` to work, you need to first remove
7379
the ``openpnm`` that you've previously installed using ``pip`` (via
7480
``pip uninstall openpnm``) or ``conda`` (via ``conda remove openpnm``).
7581

7682
Where's my ``conda`` prompt?
77-
###################################
83+
############################
7884
All the commands in this page need to be typed in the ``conda`` prompt.
7985

8086
Windows
8187
-------
8288
On Windows you should have a shortcut to the "Anaconda prompt" in the
8389
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``,
8591
such as installing things via ``conda``.
8692

8793
Mac and Linux

0 commit comments

Comments
 (0)