Skip to content

Commit 08c7b61

Browse files
committed
updated the README and installation instructions in the docs to mention that setting the PYTHONPATH is only necessary if using pyro as a python module
1 parent b48f276 commit 08c7b61

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,9 @@ https://pyro2.readthedocs.io/
7070
- The remaining steps are:
7171

7272
* Set the `PYTHONPATH` environment variable to point to the `pyro2/`
73-
directory.
73+
directory (note this is only needed if you wish to use pyro as a python
74+
module - this step is not necessary if you only run pyro via the
75+
commandline using the `pyro.py` script).
7476

7577
* Define the environment variable `PYRO_HOME` to point to the
7678
`pyro2/` directory (only needed for regression testing)

docs/source/installation.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,18 @@ The following python packages are required:
1818

1919
The following steps are needed before running pyro:
2020

21-
* add ``pyro/`` to your ``PYTHONPATH`` environment variable. For
21+
* add ``pyro/`` to your ``PYTHONPATH`` environment variable (note this is only
22+
needed if you wish to use pyro as a python
23+
module - this step is not necessary if you only run pyro via the
24+
commandline using the `pyro.py` script). For
2225
the bash shell, this is done as:
2326

2427
.. code-block:: none
2528
2629
export PYTHONPATH="/path/to/pyro/:${PYTHONPATH}"
2730
2831
* define the environment variable ``PYRO_HOME`` to point to
29-
the ``pyro2/`` directory
32+
the ``pyro2/`` directory (only needed for regression testing)
3033

3134
.. code-block:: none
3235

0 commit comments

Comments
 (0)