Skip to content

Commit

Permalink
Merge pull request #3716 from neutrinoceros/update_amrvac_doc
Browse files Browse the repository at this point in the history
DOC: fix an error in AMRVAC specific documentation
  • Loading branch information
Xarthisius committed Dec 14, 2021
2 parents 0d5471a + 84667a8 commit 800a271
Showing 1 changed file with 4 additions and 9 deletions.
13 changes: 4 additions & 9 deletions doc/source/examining/loading_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,6 @@ This will return a list of possible filenames; more information can be accessed
AMRVAC Data
-----------

.. note::

This frontend is brand new and may be subject to rapid change in the
near future.

To load data to yt, simply use

.. code-block::
Expand All @@ -60,15 +55,15 @@ Starting from AMRVAC 2.2, and datfile format 5, a geometry flag
(e.g. "Cartesian_2.5D", "Polar_2D", "Cylindrical_1.5D"...) was added
to the datfile header. yt will fall back to a cartesian mesh if the
geometry flag is not found. For older datfiles however it is possible
to provide it externally with the ``override_geometry`` parameter.
to provide it externally with the ``geometry_override`` parameter.

.. code-block:: python
# examples
ds = yt.load("output0010.dat", override_geometry="polar")
ds = yt.load("output0010.dat", override_geometry="cartesian")
ds = yt.load("output0010.dat", geometry_override="polar")
ds = yt.load("output0010.dat", geometry_override="cartesian")
Note that ``override_geometry`` has priority over any ``geometry`` flag
Note that ``geometry_override`` has priority over any ``geometry`` flag
present in recent datfiles, which means it can be used to force ``r``
VS ``theta`` 2D plots in polar geometries (for example), but this may
produce unpredictable behaviour and comes with no guarantee.
Expand Down

0 comments on commit 800a271

Please sign in to comment.