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

DOC: replace boxlib with amrex references in the docs #4925

Merged
merged 4 commits into from
Jun 14, 2024
Merged

DOC: replace boxlib with amrex references in the docs #4925

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cce4163
replace boxlib with amrex references in the docs
chrishavlin Jun 13, 2024
470172a
add ipykernel to doc reqs
chrishavlin Jun 13, 2024
c25b093
fix typo in docs
chrishavlin Jun 13, 2024
4b77a51
pin ipykernel>=6.29.4 for docs
chrishavlin Jun 13, 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
9 changes: 5 additions & 4 deletions doc/source/developing/creating_frontend.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,16 @@ called ``_is_valid()`` that lets the ``yt.load`` method help identify an
input file as belonging to *this* particular ``Dataset`` subclass
(see :ref:`data-format-detection`).
For the most part, the examples of
``yt.frontends.boxlib.data_structures.OrionDataset`` and
``yt.frontends.amrex.data_structures.OrionDataset`` and
``yt.frontends.enzo.data_structures.EnzoDataset`` should be followed,
but ``yt.frontends.chombo.data_structures.ChomboDataset``, as a
slightly newer addition, can also be used as an instructive example.

A new set of fields must be added in the file ``fields.py`` in your
new directory. For the most part this means subclassing
``FieldInfoContainer`` and adding the necessary fields specific to
your code. Here is a snippet from the base BoxLib field container:
your code. Here is a snippet from the base BoxLib field container (defined in
``yt.frontends.amrex.fields``):

.. code-block:: python

Expand Down Expand Up @@ -273,7 +274,7 @@ that is needed:


Even one of the more complex grid objects,
``yt.frontends.boxlib.BoxlibGrid``, is still relatively simple.
``yt.frontends.amrex.BoxlibGrid``, is still relatively simple.

Data Reading Functions
----------------------
Expand Down Expand Up @@ -310,7 +311,7 @@ At a minimum, one should also override the following methods
If your dataset has particle information, you'll want to override the
``_read_particle_coords()`` and ``read_particle_fields()`` methods as
well. Each code is going to read data from disk in a different
fashion, but the ``yt.frontends.boxlib.io.IOHandlerBoxlib`` is a
fashion, but the ``yt.frontends.amrex.io.IOHandlerBoxlib`` is a
decent place to start.

And that just about covers it. Please feel free to email
Expand Down
4 changes: 2 additions & 2 deletions doc/source/examining/loading_data.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -558,8 +558,8 @@ using a ``parameters`` dict, accepting the following keys:
AMReX / BoxLib Data
-------------------

AMReX and BoxLib share a frontend (currently named ``boxlib``), since
the file format nearly identical. yt has been tested with AMReX/BoxLib
AMReX and BoxLib share a frontend, since
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't this sentence missing a verb ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh ya! good catch, might as well fix that too :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(but will wait to see how the docs build goes)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

verb added to the next line!

the file format is nearly identical. yt has been tested with AMReX/BoxLib
data generated by Orion, Nyx, Maestro, Castro, IAMR, and
WarpX. Currently it is cared for by a combination of Andrew Myers,
Matthew Turk, and Mike Zingale.
Expand Down
24 changes: 12 additions & 12 deletions doc/source/reference/api/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,18 +217,18 @@ AMReX/Boxlib

.. autosummary::

~yt.frontends.boxlib.data_structures.BoxlibGrid
~yt.frontends.boxlib.data_structures.BoxlibHierarchy
~yt.frontends.boxlib.data_structures.BoxlibDataset
~yt.frontends.boxlib.data_structures.CastroDataset
~yt.frontends.boxlib.data_structures.MaestroDataset
~yt.frontends.boxlib.data_structures.NyxHierarchy
~yt.frontends.boxlib.data_structures.NyxDataset
~yt.frontends.boxlib.data_structures.OrionHierarchy
~yt.frontends.boxlib.data_structures.OrionDataset
~yt.frontends.boxlib.fields.BoxlibFieldInfo
~yt.frontends.boxlib.io.IOHandlerBoxlib
~yt.frontends.boxlib.io.IOHandlerOrion
~yt.frontends.amrex.data_structures.BoxlibGrid
~yt.frontends.amrex.data_structures.BoxlibHierarchy
~yt.frontends.amrex.data_structures.BoxlibDataset
~yt.frontends.amrex.data_structures.CastroDataset
~yt.frontends.amrex.data_structures.MaestroDataset
~yt.frontends.amrex.data_structures.NyxHierarchy
~yt.frontends.amrex.data_structures.NyxDataset
~yt.frontends.amrex.data_structures.OrionHierarchy
~yt.frontends.amrex.data_structures.OrionDataset
~yt.frontends.amrex.fields.BoxlibFieldInfo
~yt.frontends.amrex.io.IOHandlerBoxlib
~yt.frontends.amrex.io.IOHandlerOrion

CfRadial
^^^^^^^^
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,7 @@ full = [
doc = [
"alabaster>=0.7.13",
"bottle>=0.12.25",
"ipykernel>=6.29.4",
"jinja2<3.1.0", # see https://github.com/readthedocs/readthedocs.org/issues/9037
"jupyter-client>=8.3.1",
"nbsphinx>=0.9.3",
Expand Down
Loading