[yt-svn] commit/yt: 2 new changesets
commits-noreply at bitbucket.org
commits-noreply at bitbucket.org
Fri Jul 14 07:22:18 PDT 2017
2 new commits in yt:
https://bitbucket.org/yt_analysis/yt/commits/c73b9b81f15f/
Changeset: c73b9b81f15f
User: ngoldbaum
Date: 2017-07-05 20:20:48+00:00
Summary: fix issues with documentation of unit_base keyword argument
Affected #: 1 file
diff -r fc58054806fe06993c0fc585939e8fd48552c117 -r c73b9b81f15f3acc315131a674704a2ae9731458 doc/source/examining/loading_data.rst
--- a/doc/source/examining/loading_data.rst
+++ b/doc/source/examining/loading_data.rst
@@ -993,7 +993,7 @@
Gadget data in raw binary format can also be loaded with the ``load`` command.
This is supported for snapshots created with the ``SnapFormat`` parameter
-set to 1 (the standard for Gadget-2) or 2.
+set to 1 or 2.
.. code-block:: python
@@ -1006,24 +1006,46 @@
^^^^^^^^^^^^^^^^^^^^^^^^
There are two additional pieces of information that may be needed. If your
-simulation is cosmological, yt can often guess the bounding box and the units
-of the simulation. However, for isolated simulations and for cosmological
-simulations with non-standard units, these must be supplied. For example, if
-a length unit of 1.0 corresponds to a kiloparsec, you can supply this in the
-constructor. yt can accept units such as ``Mpc``, ``kpc``, ``cm``, ``Mpccm/h``
-and so on. In particular, note that ``Mpc/h`` and ``Mpccm/h`` (``cm`` for
-comoving here) are usable unit definitions.
+simulation is cosmological, yt can often guess the bounding box and the units of
+the simulation. However, for isolated simulations and for cosmological
+simulations with non-standard units, these must be supplied by the user. For
+example, if a length unit of 1.0 corresponds to a kiloparsec, you can supply
+this in the constructor. yt can accept units such as ``Mpc``, ``kpc``, ``cm``,
+``Mpccm/h`` and so on. In particular, note that ``Mpc/h`` and ``Mpccm/h``
+(``cm`` for comoving here) are usable unit definitions.
yt will attempt to use units for ``mass``, ``length`` and ``time`` as supplied
in the argument ``unit_base``. The ``bounding_box`` argument is a list of
two-item tuples or lists that describe the left and right extents of the
-particles.
+particles. In this example we load a dataset with a custom bounding box
+and units.
.. code-block:: python
- ds = GadgetDataset("snap_004",
- unit_base = {'length': ('kpc', 1.0)},
- bounding_box = [[-600.0, 600.0], [-600.0, 600.0], [-600.0, 600.0]])
+
+ bbox = [[-600.0, 600.0], [-600.0, 600.0], [-600.0, 600.0]]
+ unit_base = {
+ 'length': (1.0, 'kpc'),
+ 'velocity: (1.0, 'km/s'),
+ 'mass': (1.0, 'Msun')
+ }
+
+ ds = yt.load("snap_004", unit_base=unit_base, bounding_box=bbox)
+
+In addition, you can use ``UnitLength_in_cm``, ``UnitVelocity_in_cm_per_s``,
+and ``UnitMass_in_g`` as keys for the ``unit_base`` dictionary. These names
+come from the names used in the Gadget runtime parameter file. This example
+will initialize a dataset with the same units as the example above:
+
+.. code-block:: python
+
+ unit_base = {
+ 'UnitLength_in_cm': 3.09e21,
+ 'UnitVelocity_in_cm_per_s': 1e5
+ 'UnitMass_in_g': 1.989e33
+ }
+
+ ds = yt.load("snap_004", unit_base=unit_base, bounding_box=bbox)
.. _particle-indexing-criteria:
https://bitbucket.org/yt_analysis/yt/commits/2f8b04fe5a0a/
Changeset: 2f8b04fe5a0a
User: ngoldbaum
Date: 2017-07-14 14:22:00+00:00
Summary: Merge pull request #1481 from ngoldbaum/gadget-load-fix
Fix issues with documentation of unit_base keyword argument for loading gadget data
Affected #: 1 file
diff -r 1d289fca31c306ae5f0bd3cefb5ccb26d0504092 -r 2f8b04fe5a0aa7b734d07037b2594a87541c1630 doc/source/examining/loading_data.rst
--- a/doc/source/examining/loading_data.rst
+++ b/doc/source/examining/loading_data.rst
@@ -1023,7 +1023,7 @@
Gadget data in raw binary format can also be loaded with the ``load`` command.
This is supported for snapshots created with the ``SnapFormat`` parameter
-set to 1 (the standard for Gadget-2) or 2.
+set to 1 or 2.
.. code-block:: python
@@ -1036,24 +1036,46 @@
^^^^^^^^^^^^^^^^^^^^^^^^
There are two additional pieces of information that may be needed. If your
-simulation is cosmological, yt can often guess the bounding box and the units
-of the simulation. However, for isolated simulations and for cosmological
-simulations with non-standard units, these must be supplied. For example, if
-a length unit of 1.0 corresponds to a kiloparsec, you can supply this in the
-constructor. yt can accept units such as ``Mpc``, ``kpc``, ``cm``, ``Mpccm/h``
-and so on. In particular, note that ``Mpc/h`` and ``Mpccm/h`` (``cm`` for
-comoving here) are usable unit definitions.
+simulation is cosmological, yt can often guess the bounding box and the units of
+the simulation. However, for isolated simulations and for cosmological
+simulations with non-standard units, these must be supplied by the user. For
+example, if a length unit of 1.0 corresponds to a kiloparsec, you can supply
+this in the constructor. yt can accept units such as ``Mpc``, ``kpc``, ``cm``,
+``Mpccm/h`` and so on. In particular, note that ``Mpc/h`` and ``Mpccm/h``
+(``cm`` for comoving here) are usable unit definitions.
yt will attempt to use units for ``mass``, ``length`` and ``time`` as supplied
in the argument ``unit_base``. The ``bounding_box`` argument is a list of
two-item tuples or lists that describe the left and right extents of the
-particles.
+particles. In this example we load a dataset with a custom bounding box
+and units.
.. code-block:: python
- ds = GadgetDataset("snap_004",
- unit_base = {'length': ('kpc', 1.0)},
- bounding_box = [[-600.0, 600.0], [-600.0, 600.0], [-600.0, 600.0]])
+
+ bbox = [[-600.0, 600.0], [-600.0, 600.0], [-600.0, 600.0]]
+ unit_base = {
+ 'length': (1.0, 'kpc'),
+ 'velocity: (1.0, 'km/s'),
+ 'mass': (1.0, 'Msun')
+ }
+
+ ds = yt.load("snap_004", unit_base=unit_base, bounding_box=bbox)
+
+In addition, you can use ``UnitLength_in_cm``, ``UnitVelocity_in_cm_per_s``,
+and ``UnitMass_in_g`` as keys for the ``unit_base`` dictionary. These names
+come from the names used in the Gadget runtime parameter file. This example
+will initialize a dataset with the same units as the example above:
+
+.. code-block:: python
+
+ unit_base = {
+ 'UnitLength_in_cm': 3.09e21,
+ 'UnitVelocity_in_cm_per_s': 1e5
+ 'UnitMass_in_g': 1.989e33
+ }
+
+ ds = yt.load("snap_004", unit_base=unit_base, bounding_box=bbox)
.. _particle-indexing-criteria:
Repository URL: https://bitbucket.org/yt_analysis/yt/
--
This is a commit notification from bitbucket.org. You are receiving
this because you have the service enabled, addressing the recipient of
this email.
More information about the yt-svn
mailing list