Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some docs tweaks #222

Merged
merged 2 commits into from
Aug 31, 2024
Merged

Some docs tweaks #222

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9c733e4
highlight some portions of the docs
zingale Aug 31, 2024
fe6d33d
more doc fixes
zingale Aug 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/design.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ two sub-directories for problems and tests, appearing as:
* *solver-name*

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

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

Expand Down
23 changes: 13 additions & 10 deletions docs/source/running.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
Running
=======

Pyro can be run in two ways: either from the commandline, using the
``pyro_sim.py`` script (this will be installed into your search path)
and passing in the solver, problem and inputs as arguments, or by
using the :func:`Pyro <pyro.pyro_sim.Pyro>` class.
Pyro can be run in two ways:

* from the commandline, using the ``pyro_sim.py`` script (this will be installed into your search path)

* by using the :func:`Pyro <pyro.pyro_sim.Pyro>` class directly in ipython or Jupyter

Commandline
------------
Expand Down Expand Up @@ -79,7 +80,7 @@ visualization for the previous example, we would do:

.. code-block:: python

parameters = {"vis.dovis":0}
parameters = {"vis.dovis": 0}
p.initialize_problem(problem_name="kh",
inputs_file="inputs.kh",
inputs_dict=parameters)
Expand Down Expand Up @@ -132,11 +133,13 @@ as:
...
cfl = rp.get_param("hydro.cfl")

When pyro is run, the file ``inputs.auto`` is output containing the
full list of runtime parameters, their value for the simulation, and
the comment that was associated with them from the ``_defaults``
files. This is a useful way to see what parameters are in play for a
given simulation.
.. tip::

When pyro is run, the file ``inputs.auto`` is output containing the
full list of runtime parameters, their value for the simulation, and
the comment that was associated with them from the ``_defaults``
files. This is a useful way to see what parameters are in play for a
given simulation.

All solvers use the following parameters:

Expand Down