Skip to content

Commit

Permalink
separate the mesh docs into their own section (#221)
Browse files Browse the repository at this point in the history
  • Loading branch information
zingale authored Aug 31, 2024
1 parent 9108a53 commit 710e6f4
Show file tree
Hide file tree
Showing 5 changed files with 231 additions and 128 deletions.
6 changes: 6 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,14 @@ pyro: a python hydro code
running
output
problems

.. toctree::
maxdepth: 1
:caption: mesh

mesh_basics
mesh-examples.ipynb
spherical-mesh.ipynb

.. toctree::
:maxdepth: 1
Expand Down
9 changes: 0 additions & 9 deletions docs/source/mesh_basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -96,15 +96,6 @@ Note that each variable needs to specify a BC—this allows us to do
different actions for each variable (for example, some may do even
reflection while others may do odd reflection).

Jupyter notebook
----------------

A Jupyter notebook that illustrates some of the basics of working with
the grid is provided as `mesh-examples.ipynb <https://github.com/python-hydro/pyro2/blob/main/pyro/mesh/mesh-examples.ipynb>`_. This will
demonstrate, for example, how to use the :func:`ArrayIndexer <pyro.mesh.array_indexer.ArrayIndexer>` methods to
construct differences.


Tests
-----

Expand Down
1 change: 1 addition & 0 deletions docs/source/spherical-mesh.ipynb
144 changes: 25 additions & 119 deletions pyro/mesh/mesh-examples.ipynb

Large diffs are not rendered by default.

199 changes: 199 additions & 0 deletions pyro/mesh/spherical-mesh.ipynb

Large diffs are not rendered by default.

0 comments on commit 710e6f4

Please sign in to comment.