Skip to content

Commit

Permalink
more work on the docs intro
Browse files Browse the repository at this point in the history
  • Loading branch information
zingale committed Feb 6, 2025
1 parent b0839d1 commit 672772e
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 5 deletions.
2 changes: 2 additions & 0 deletions Docs/source/burn_cell.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _sec:burn_cell:

*************
``burn_cell``
*************
Expand Down
16 changes: 13 additions & 3 deletions Docs/source/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,17 +58,27 @@ one-zone burn. In ``Microphysics/`` do:
cd unit_test/burn_cell
make

This will create an executable called ``main3d.gnu.ex``. Then you can run it as:
This will create an executable called ``main3d.gnu.ex``.
By default, the test is built with the 13-isotope ``aprox13`` network,
``helmholtz`` EOS, and VODE integrator.


Then you can run it as:

.. prompt:: bash

./main3d.gnu.ex inputs_aprox13

By default, the test is built with the 13-isotope ``aprox13`` network,
``helmholtz`` EOS, and VODE integrator.
Here ``inputs_aprox13`` is the inputs file that sets options.

This will output information about the starting and final state to the
terminal and produce a file ``state_over_time.txt`` that contains the
thermodynamic history at different points in time.

.. note::

See the :ref:`sec:burn_cell` documentation for more details on this
unit test and how to visualize the output.

Running with AMReX Application Code
===================================
Expand Down
3 changes: 1 addition & 2 deletions Docs/source/rp_intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The behavior of the network and EOS are controlled by many runtime
parameters. These parameters are defined in plain-text files
``_parameters`` located in the different directories that hold the
microphysics code. At compile time, a script in the AMReX build
system, findparams.py, locates all of the ``_parameters`` files that
system, ``findparams.py``, locates all of the ``_parameters`` files that
are needed for the given choice of network, integrator, and EOS, and
assembles all of the runtime parameters into a set of header files
(using the ``write_probin.py`` script).
Expand All @@ -32,4 +32,3 @@ noted in separate tables.
.. toctree::

runtime_parameters

0 comments on commit 672772e

Please sign in to comment.