Skip to content

Commit 6b1a81b

Browse files
committed
add pip to install
1 parent a35d9e2 commit 6b1a81b

3 files changed

Lines changed: 17 additions & 8 deletions

File tree

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,16 +56,19 @@ https://python-hydro.github.io/pyro2
5656
- We require `numpy`, `numba`, `matplotlib`, and `h5py` for running pyro
5757
and `setuptools_scm` for the install.
5858

59-
- We recommend that pyro be installed so that it is found in your python search
60-
path, and can work more easily with Jupyter notebooks.
59+
- There are several ways to install pyro. The simplest way is via PyPI/pip:
6160

62-
pyro can be installed on your system via:
61+
```
62+
pip install pyro-hydro
63+
```
64+
65+
Alternately, you can install directly from source, via
6366
6467
```
6568
python setup.py install --user
6669
```
6770
68-
alternately, you can use `develop` instead of `install` if you are
71+
or you can use `develop` instead of `install` if you are
6972
planning on developing pyro solvers directly.
7073
7174
- Not all matplotlib backends allow for the interactive plotting as

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
pyro: a python hydro code
88
*************************
99

10-
`http://github.com/python-hydro/pyro2 <http://github.com/python-hydro/pyro2>`_
10+
`https://github.com/python-hydro/pyro2 <https://github.com/python-hydro/pyro2>`_
1111

1212
.. image:: pyro_plots.png
1313

docs/source/installation.rst

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Setting up pyro
22
===============
33

4-
You can clone pyro from github: `http://github.com/python-hydro/pyro2 <http://github.com/python-hydro/pyro2>`_
4+
You can clone pyro from github: `https://github.com/python-hydro/pyro2 <https://github.com/python-hydro/pyro2>`_
55

66
The following python packages are required:
77

@@ -11,8 +11,14 @@ The following python packages are required:
1111
* ``h5py``
1212
* ``pytest`` (for unit tests)
1313

14-
The easiest way to install python is to use the ``setup.py``. From
15-
the ``pyro2/`` directory, we do:
14+
The easiest way to install python is via PyPI using pip:
15+
16+
.. prompt:: bash
17+
18+
pip install pyro-hydro
19+
20+
Alternately, you can install from source, using the ``setup.py``.
21+
From the ``pyro2/`` directory, we do:
1622

1723
.. prompt:: bash
1824

0 commit comments

Comments
 (0)