@@ -49,13 +49,22 @@ https://pyro2.readthedocs.io/
4949
5050## Getting started
5151
52- - By default, we assume python 3.6 or later.
52+ - By default, we assume python 3.8 or later.
5353
54- - There are a few steps to take to get things running. You need to
55- make sure you have ` numpy ` , ` numba ` , ` matplotlib ` , and ` h5py `
56- installed. On a Fedora system, this can be accomplished by doing:
54+ - We require ` numpy ` , ` numba ` , ` matplotlib ` , and ` h5py ` for running pyro
55+ and ` setuptools_scm ` for the install.
5756
58- ` dnf install python3-numpy python3-numba python3-matplotlib python3-matplotlib-tk python3-h5py `
57+ - We recommend that pyro be installed so that it is found in your python search
58+ path, and can work more easily with Jupyter notebooks.
59+
60+ pyro can be installed on your system via:
61+
62+ ```
63+ python setup.py install --user
64+ ```
65+
66+ alternately, you can use `develop` instead of `install` if you are
67+ planning on developing pyro solvers directly.
5968
6069 - Not all matplotlib backends allow for the interactive plotting as
6170 pyro is run. One that does is the TkAgg backend. This can be made
@@ -64,31 +73,23 @@ https://pyro2.readthedocs.io/
6473
6574 `backend: TkAgg`
6675
67- You can check what backend is your current default in python via:
76+ You can check what backend is your current default in python via:
6877
69- ``` python
70- import matplotlib.pyplot
71- print matplotlib.pyplot.get_backend()
78+ ```python
79+ import matplotlib.pyplot
80+ print matplotlib.pyplot.get_backend()
7281 ```
7382
74- - If you want to run the unit tests, you need to have `pytest` installed.
75-
76- - The remaining steps are:
83+ - If you want to run the unit tests, you need to have `pytest` installed.
7784
78- * Set the `PYTHONPATH ` environment variable to point to the `pyro2/ `
79- directory (note this is only needed if you wish to use pyro as a python
80- module - this step is not necessary if you only run pyro via the
81- commandline using the `pyro.py` script).
85+ - Finally, you can run a quick test of the advection solver:
8286
83- * Define the environment variable `PYRO_HOME ` to point to the
84- `pyro2/ ` directory (only needed for regression testing)
87+ ```
88+ ./pyro-sim.py advection smooth inputs.smooth
89+ ```
8590
86- * Run a quick test of the advection solver:
87-
88- `./ pyro.py advection smooth inputs.smooth`
89-
90- you should see a graphing window pop up with a smooth pulse
91- advecting diagonally through the periodic domain.
91+ you should see a graphing window pop up with a smooth pulse
92+ advecting diagonally through the periodic domain.
9293
9394
9495## Core Data Structures
@@ -98,6 +99,7 @@ on the grid are described in a jupyter notebook:
9899
99100https://github.com/python-hydro/pyro2/blob/main/mesh/mesh-examples.ipynb
100101
102+
101103Many of the methods here rely on multigrid. The multigrid solver is
102104demonstrated in the juputer notebook:
103105
@@ -139,7 +141,7 @@ pyro provides the following solvers (all in 2-d):
139141 characteristic tracing.
140142
141143 - `compressible_sdc`: a fourth-order compressible solver,
142- using spectral- deferred correction (SDC ) for the time integration.
144+ using spectral-deferred correction (SDC) for the time integration.
143145
144146 - `diffusion`: a Crank-Nicolson time-discretized solver for the
145147 constant-coefficient diffusion equation.
0 commit comments