Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
yt-project
GitHub Repository: yt-project/yt
Path: blob/main/doc/source/reference/code_support.rst
928 views

.. _code-support:

Code Support
============

Levels of Support for Various Codes
-----------------------------------

yt provides frontends to support several different simulation code formats
as inputs.  Below is a list showing what level of support is provided for
each code. See :ref:`loading-data` for examples of loading a dataset from
each supported output format using yt.

+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| Capability ►          | Fluid      | Particles | Parameters | Units | Read on  | Load Raw | Part of    | Level of    |
| Code/Format ▼         | Quantities |           |            |       | Demand   | Data     | test suite | Support     |
+=======================+============+===========+============+=======+==========+==========+============+=============+
| AMRVAC                |     Y      |     N     |      Y     |   Y   |    Y     |    Y     |     Y      | Partial     |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| AREPO                 |     Y      |     Y     |      Y     |   Y   |    Y     |    Y     |     Y      | Full [#f4]_ |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| ART                   |     Y      |     Y     |      Y     |   Y   | Y [#f2]_ |    Y     |     N      |   Full      |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| ARTIO                 |     Y      |     Y     |      Y     |   Y   |    Y     |    Y     |     Y      |   Full      |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| Athena                |     Y      |     N     |      Y     |   Y   |    Y     |    Y     |     Y      |   Full      |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| Athena++              |     Y      |     N     |      Y     |   Y   |    Y     |    Y     |     Y      | Partial     |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| Castro                |     Y      |  Y [#f3]_ |   Partial  |   Y   |    Y     |    Y     |     N      |   Full      |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| CfRadial              |     Y      |    N/A    |      Y     |   Y   |    Y     |    Y     |     Y      |   [#f5]_    |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| CHOLLA                |     Y      |    N/A    |      Y     |   Y   |    Y     |    Y     |     Y      |   Full      |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| Chombo                |     Y      |     Y     |      Y     |   Y   |    Y     |    Y     |     Y      |   Full      |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| Enzo                  |     Y      |     Y     |      Y     |   Y   |    Y     |    Y     |     Y      |   Full      |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| Enzo-E                |     Y      |     Y     |      Y     |   Y   |    Y     |    Y     |     Y      |   Full      |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| Exodus II             |     ?      |     ?     |      ?     |   ?   |    ?     |    ?     |     ?      |   ?         |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| FITS                  |     Y      |    N/A    |      Y     |   Y   |    Y     |    Y     |     Y      |   Full      |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| FLASH                 |     Y      |     Y     |      Y     |   Y   |    Y     |    Y     |     Y      |   Full      |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| Gadget                |     Y      |     Y     |      Y     |   Y   |    Y     |    Y     |     Y      |   Full      |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| GAMER                 |     Y      |     Y     |      Y     |   Y   |    Y     |    Y     |     Y      |   Full      |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| Gasoline              |     Y      |     Y     |      Y     |   Y   |    Y     |    Y     |     Y      |   Full      |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| Gizmo                 |     Y      |     Y     |      Y     |   Y   |    Y     |    Y     |     Y      |   Full      |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| Grid Data Format (GDF)|     Y      |    N/A    |      Y     |   Y   |    Y     |    Y     |     Y      |   Full      |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| IAMR                  |     ?      |     ?     |      ?     |   ?   |    ?     |    ?     |     ?      | ?           |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| Maestro               |   Y [#f1]_ |     N     |      Y     |   Y   |    Y     |    Y     |     N      | Partial     |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| MOAB                  |     Y      |    N/A    |      Y     |   Y   |    Y     |    Y     |     Y      |   Full      |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| Nyx                   |     Y      |     Y     |      Y     |   Y   |    Y     |    Y     |     Y      |   Full      |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| openPMD               |     Y      |     Y     |      N     |   Y   |    Y     |    Y     |     N      | Partial     |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| Orion                 |     Y      |     Y     |      Y     |   Y   |    Y     |    Y     |     Y      |   Full      |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| OWLS/EAGLE            |     Y      |     Y     |      Y     |   Y   |    Y     |    Y     |     Y      |   Full      |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| Parthenon             |     Y      |     N     |      Y     |   Y   |    Y     |    Y     |     Y      | Partial     |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| Piernik               |     Y      |    N/A    |      Y     |   Y   |    Y     |    Y     |     Y      |   Full      |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| Pluto                 |     Y      |     N     |      Y     |   Y   |    Y     |    Y     |     Y      | Partial     |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| RAMSES                |     Y      |     Y     |      Y     |   Y   | Y [#f2]_ |    Y     |     Y      |   Full      |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| Tipsy                 |     Y      |     Y     |      Y     |   Y   |    Y     |    Y     |     Y      |   Full      |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+
| WarpX                 |     Y      |     Y     |      Y     |   Y   |    Y     |    Y     |     Y      |   Full      |
+-----------------------+------------+-----------+------------+-------+----------+----------+------------+-------------+

.. [#f1] one-dimensional base-state not read in currently.
.. [#f2] These handle mesh fields using an in-memory octree that has not been parallelized.
         Datasets larger than approximately 1024^3 will not scale well.
.. [#f3] Newer versions of Castro that use BoxLib's standard particle format are supported.
          The older ASCII format is not.
.. [#f4] The Voronoi cells are currently treated as SPH-like particles, with a smoothing
         length proportional to the cube root of the cell volume.
.. [#f5] yt provides support for cartesian-gridded CfRadial datasets. Data in native
         CFRadial coordinates will be gridded on load, see :ref:`loading-cfradial-data`.

If you have a dataset that uses an output format not yet supported by yt, you
can either input your data following :doc:`../examining/Loading_Generic_Array_Data` or
:doc:`../examining/Loading_Generic_Particle_Data`, or help us by :ref:`creating_frontend`
for this new format.