diff --git a/doc/source/developing/creating_frontend.rst b/doc/source/developing/creating_frontend.rst index 2678d3abecb..c11d1feba07 100644 --- a/doc/source/developing/creating_frontend.rst +++ b/doc/source/developing/creating_frontend.rst @@ -56,7 +56,7 @@ 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. @@ -64,7 +64,8 @@ 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 @@ -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 ---------------------- @@ -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 diff --git a/doc/source/examining/loading_data.rst b/doc/source/examining/loading_data.rst index 605614b2de3..04157123678 100644 --- a/doc/source/examining/loading_data.rst +++ b/doc/source/examining/loading_data.rst @@ -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 +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. diff --git a/doc/source/reference/api/api.rst b/doc/source/reference/api/api.rst index 61b63f2c15f..3cc192c5787 100644 --- a/doc/source/reference/api/api.rst +++ b/doc/source/reference/api/api.rst @@ -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 ^^^^^^^^ diff --git a/pyproject.toml b/pyproject.toml index 0fe215c7a77..9efa1f8d692 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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",