Skip to content

Commit ed25543

Browse files
authored
Some docs tweaks (#222)
1 parent 710e6f4 commit ed25543

File tree

2 files changed

+14
-11
lines changed

2 files changed

+14
-11
lines changed

docs/source/design.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ two sub-directories for problems and tests, appearing as:
4747
* *solver-name*
4848

4949
* ``problems/`` : the problem setups and inputs file that work for this solver.
50-
In some cases, this might be a symlink to a similar solver that we inherit from.
50+
In some cases, this might be a symlink to a similar solver that we inherit from.
5151

5252
* ``tests/``. reference output (HDF5 files) used for the regression testing.
5353

docs/source/running.rst

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
Running
22
=======
33

4-
Pyro can be run in two ways: either from the commandline, using the
5-
``pyro_sim.py`` script (this will be installed into your search path)
6-
and passing in the solver, problem and inputs as arguments, or by
7-
using the :func:`Pyro <pyro.pyro_sim.Pyro>` class.
4+
Pyro can be run in two ways:
5+
6+
* from the commandline, using the ``pyro_sim.py`` script (this will be installed into your search path)
7+
8+
* by using the :func:`Pyro <pyro.pyro_sim.Pyro>` class directly in ipython or Jupyter
89

910
Commandline
1011
------------
@@ -79,7 +80,7 @@ visualization for the previous example, we would do:
7980

8081
.. code-block:: python
8182
82-
parameters = {"vis.dovis":0}
83+
parameters = {"vis.dovis": 0}
8384
p.initialize_problem(problem_name="kh",
8485
inputs_file="inputs.kh",
8586
inputs_dict=parameters)
@@ -132,11 +133,13 @@ as:
132133
...
133134
cfl = rp.get_param("hydro.cfl")
134135
135-
When pyro is run, the file ``inputs.auto`` is output containing the
136-
full list of runtime parameters, their value for the simulation, and
137-
the comment that was associated with them from the ``_defaults``
138-
files. This is a useful way to see what parameters are in play for a
139-
given simulation.
136+
.. tip::
137+
138+
When pyro is run, the file ``inputs.auto`` is output containing the
139+
full list of runtime parameters, their value for the simulation, and
140+
the comment that was associated with them from the ``_defaults``
141+
files. This is a useful way to see what parameters are in play for a
142+
given simulation.
140143

141144
All solvers use the following parameters:
142145

0 commit comments

Comments
 (0)