Skip to content

Commit

Permalink
update some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
zingale committed Apr 22, 2024
1 parent 2df4f27 commit 900be90
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/source/design.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ pyro follows a standard python package structure. The main directory

* ``www/`` : the logo used in the website

It is at this level (``pyro2/``) that the installation of pyro is done (via ``setup.py``).
It is at this level (``pyro2/``) that the installation of pyro is done (via ``pyproject.toml``).

``pyro/``
^^^^^^^^^
Expand Down
6 changes: 3 additions & 3 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ The easiest way to install python is via PyPI using pip:

pip install pyro-hydro

Alternately, you can install from source, using the ``setup.py``.
Alternately, you can install from source.
From the ``pyro2/`` directory, we do:

.. prompt:: bash

python setup.py install --user
pip install .

This will put the main driver, ``pyro_sim.py``, in your path, and
allow you to run pyro from anywhere.
Expand All @@ -31,7 +31,7 @@ If you intend on directly developing the solvers, you can instead do:

.. prompt:: bash

python setup.py develop --user
pip install -e .

This will allow you to modify the python source without having to
reinstall each time something changes.
Expand Down
2 changes: 1 addition & 1 deletion postBuild
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/bin/bash

python setup.py install
pip install .


0 comments on commit 900be90

Please sign in to comment.