[yt-svn] commit/yt: 2 new changesets
commits-noreply at bitbucket.org
commits-noreply at bitbucket.org
Tue Mar 8 12:33:08 PST 2016
2 new commits in yt:
https://bitbucket.org/yt_analysis/yt/commits/69df8cf9aa20/
Changeset: 69df8cf9aa20
Branch: yt
User: ngoldbaum
Date: 2016-03-07 20:18:34+00:00
Summary: Fixing a number of sphinx errors and warnings
Affected #: 8 files
diff -r 169c6b14377e4e691657a18547322d3d0c87aae3 -r 69df8cf9aa20126daed90bff28273ba43a658129 CONTRIBUTING.rst
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -843,7 +843,7 @@
be avoided, they must be explained, even if they are only to be passed on to
a nested function.
-.. _docstrings
+.. _docstrings:
Docstrings
----------
diff -r 169c6b14377e4e691657a18547322d3d0c87aae3 -r 69df8cf9aa20126daed90bff28273ba43a658129 doc/source/analyzing/objects.rst
--- a/doc/source/analyzing/objects.rst
+++ b/doc/source/analyzing/objects.rst
@@ -246,6 +246,8 @@
| A plane normal to a specified vector and intersecting a particular
coordinate.
+.. _region-reference:
+
3D Objects
""""""""""
@@ -256,8 +258,6 @@
creating a Region covering the entire dataset domain. It is effectively
``ds.region(ds.domain_center, ds.domain_left_edge, ds.domain_right_edge)``.
-.. _region-reference:
-
**Box Region**
| Class :class:`~yt.data_objects.selection_data_containers.YTRegion`
| Usage: ``region(center, left_edge, right_edge, fields=None, ds=None, field_parameters=None, data_source=None)``
diff -r 169c6b14377e4e691657a18547322d3d0c87aae3 -r 69df8cf9aa20126daed90bff28273ba43a658129 doc/source/index.rst
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -175,6 +175,7 @@
.. toctree::
:hidden:
+ intro/index
installing
yt Quickstart <quickstart/index>
yt3differences
diff -r 169c6b14377e4e691657a18547322d3d0c87aae3 -r 69df8cf9aa20126daed90bff28273ba43a658129 doc/source/intro/index.rst
--- a/doc/source/intro/index.rst
+++ b/doc/source/intro/index.rst
@@ -49,7 +49,7 @@
the :ref:`units system <units>` works to tag every individual field and
quantity with a physical unit (e.g. cm, AU, kpc, Mpc, etc.), and it describes
ways of analyzing multiple chronological data outputs from the same underlying
-dataset known as :ref:`time series <time-series-analysis`. Lastly, it includes
+dataset known as :ref:`time series <time-series-analysis>`. Lastly, it includes
information on how to enable yt to operate :ref:`in parallel over multiple
processors simultaneously <parallel-computation>`.
diff -r 169c6b14377e4e691657a18547322d3d0c87aae3 -r 69df8cf9aa20126daed90bff28273ba43a658129 doc/source/reference/index.rst
--- a/doc/source/reference/index.rst
+++ b/doc/source/reference/index.rst
@@ -14,5 +14,6 @@
command-line
api/api
configuration
+ python_introduction
field_list
changelog
diff -r 169c6b14377e4e691657a18547322d3d0c87aae3 -r 69df8cf9aa20126daed90bff28273ba43a658129 doc/source/visualizing/index.rst
--- a/doc/source/visualizing/index.rst
+++ b/doc/source/visualizing/index.rst
@@ -16,7 +16,6 @@
manual_plotting
volume_rendering
unstructured_mesh_rendering
- hardware_volume_rendering
sketchfab
mapserver
streamlines
diff -r 169c6b14377e4e691657a18547322d3d0c87aae3 -r 69df8cf9aa20126daed90bff28273ba43a658129 doc/source/visualizing/volume_rendering.rst
--- a/doc/source/visualizing/volume_rendering.rst
+++ b/doc/source/visualizing/volume_rendering.rst
@@ -236,12 +236,13 @@
The :class:`~yt.visualization.volume_rendering.camera.Camera` object
is what it sounds like, a camera within the Scene. It possesses the
quantities:
- * :meth:`~yt.visualization.volume_rendering.camera.Camera.position` - the position of the camera in scene-space
- * :meth:`~yt.visualization.volume_rendering.camera.Camera.width` - the width of the plane the camera can see
- * :meth:`~yt.visualization.volume_rendering.camera.Camera.focus` - the point in space the camera is looking at
- * :meth:`~yt.visualization.volume_rendering.camera.Camera.resolution` - the image resolution
- * ``north_vector`` - a vector defining the "up" direction in an image
- * :ref:`lens <lenses>` - an object controlling how rays traverse the Scene
+
+* :meth:`~yt.visualization.volume_rendering.camera.Camera.position` - the position of the camera in scene-space
+* :meth:`~yt.visualization.volume_rendering.camera.Camera.width` - the width of the plane the camera can see
+* :meth:`~yt.visualization.volume_rendering.camera.Camera.focus` - the point in space the camera is looking at
+* :meth:`~yt.visualization.volume_rendering.camera.Camera.resolution` - the image resolution
+* ``north_vector`` - a vector defining the "up" direction in an image
+* :ref:`lens <lenses>` - an object controlling how rays traverse the Scene
.. _camera_movement:
@@ -482,7 +483,7 @@
their combination, are described below.
MPI Parallelization
-+++++++++++++++++++
+^^^^^^^^^^^^^^^^^^^
Currently the volume renderer is parallelized using MPI to decompose the volume
by attempting to split up the
@@ -516,7 +517,7 @@
For more information about enabling parallelism, see :ref:`parallel-computation`.
OpenMP Parallelization
-++++++++++++++++++++++
+^^^^^^^^^^^^^^^^^^^^^^
The volume rendering also parallelized using the OpenMP interface in Cython.
While the MPI parallelization is done using domain decomposition, the OpenMP
@@ -532,7 +533,7 @@
by default by modifying the environment variable OMP_NUM_THREADS.
Running in Hybrid MPI + OpenMP
-++++++++++++++++++++++++++++++
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The two methods for volume rendering parallelization can be used together to
leverage large supercomputing resources. When choosing how to balance the
diff -r 169c6b14377e4e691657a18547322d3d0c87aae3 -r 69df8cf9aa20126daed90bff28273ba43a658129 yt/visualization/volume_rendering/render_source.py
--- a/yt/visualization/volume_rendering/render_source.py
+++ b/yt/visualization/volume_rendering/render_source.py
@@ -203,7 +203,8 @@
"""Set the source's fields to render
Parameters
- ---------
+ ----------
+
fields: field name or list of field names
The field or fields to render
no_ghost: boolean
https://bitbucket.org/yt_analysis/yt/commits/f140f39046ae/
Changeset: f140f39046ae
Branch: yt
User: xarthisius
Date: 2016-03-08 20:32:56+00:00
Summary: Merged in ngoldbaum/yt (pull request #2027)
Fixing a number of sphinx errors and warnings
Affected #: 8 files
diff -r 030372da4a869adba281c0c8e301df4416d66c59 -r f140f39046ae28939112fbc616be770b5dec38ef CONTRIBUTING.rst
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -843,7 +843,7 @@
be avoided, they must be explained, even if they are only to be passed on to
a nested function.
-.. _docstrings
+.. _docstrings:
Docstrings
----------
diff -r 030372da4a869adba281c0c8e301df4416d66c59 -r f140f39046ae28939112fbc616be770b5dec38ef doc/source/analyzing/objects.rst
--- a/doc/source/analyzing/objects.rst
+++ b/doc/source/analyzing/objects.rst
@@ -246,6 +246,8 @@
| A plane normal to a specified vector and intersecting a particular
coordinate.
+.. _region-reference:
+
3D Objects
""""""""""
@@ -256,8 +258,6 @@
creating a Region covering the entire dataset domain. It is effectively
``ds.region(ds.domain_center, ds.domain_left_edge, ds.domain_right_edge)``.
-.. _region-reference:
-
**Box Region**
| Class :class:`~yt.data_objects.selection_data_containers.YTRegion`
| Usage: ``region(center, left_edge, right_edge, fields=None, ds=None, field_parameters=None, data_source=None)``
diff -r 030372da4a869adba281c0c8e301df4416d66c59 -r f140f39046ae28939112fbc616be770b5dec38ef doc/source/index.rst
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -175,6 +175,7 @@
.. toctree::
:hidden:
+ intro/index
installing
yt Quickstart <quickstart/index>
yt3differences
diff -r 030372da4a869adba281c0c8e301df4416d66c59 -r f140f39046ae28939112fbc616be770b5dec38ef doc/source/intro/index.rst
--- a/doc/source/intro/index.rst
+++ b/doc/source/intro/index.rst
@@ -49,7 +49,7 @@
the :ref:`units system <units>` works to tag every individual field and
quantity with a physical unit (e.g. cm, AU, kpc, Mpc, etc.), and it describes
ways of analyzing multiple chronological data outputs from the same underlying
-dataset known as :ref:`time series <time-series-analysis`. Lastly, it includes
+dataset known as :ref:`time series <time-series-analysis>`. Lastly, it includes
information on how to enable yt to operate :ref:`in parallel over multiple
processors simultaneously <parallel-computation>`.
diff -r 030372da4a869adba281c0c8e301df4416d66c59 -r f140f39046ae28939112fbc616be770b5dec38ef doc/source/reference/index.rst
--- a/doc/source/reference/index.rst
+++ b/doc/source/reference/index.rst
@@ -14,5 +14,6 @@
command-line
api/api
configuration
+ python_introduction
field_list
changelog
diff -r 030372da4a869adba281c0c8e301df4416d66c59 -r f140f39046ae28939112fbc616be770b5dec38ef doc/source/visualizing/index.rst
--- a/doc/source/visualizing/index.rst
+++ b/doc/source/visualizing/index.rst
@@ -16,7 +16,6 @@
manual_plotting
volume_rendering
unstructured_mesh_rendering
- hardware_volume_rendering
sketchfab
mapserver
streamlines
diff -r 030372da4a869adba281c0c8e301df4416d66c59 -r f140f39046ae28939112fbc616be770b5dec38ef doc/source/visualizing/volume_rendering.rst
--- a/doc/source/visualizing/volume_rendering.rst
+++ b/doc/source/visualizing/volume_rendering.rst
@@ -236,12 +236,13 @@
The :class:`~yt.visualization.volume_rendering.camera.Camera` object
is what it sounds like, a camera within the Scene. It possesses the
quantities:
- * :meth:`~yt.visualization.volume_rendering.camera.Camera.position` - the position of the camera in scene-space
- * :meth:`~yt.visualization.volume_rendering.camera.Camera.width` - the width of the plane the camera can see
- * :meth:`~yt.visualization.volume_rendering.camera.Camera.focus` - the point in space the camera is looking at
- * :meth:`~yt.visualization.volume_rendering.camera.Camera.resolution` - the image resolution
- * ``north_vector`` - a vector defining the "up" direction in an image
- * :ref:`lens <lenses>` - an object controlling how rays traverse the Scene
+
+* :meth:`~yt.visualization.volume_rendering.camera.Camera.position` - the position of the camera in scene-space
+* :meth:`~yt.visualization.volume_rendering.camera.Camera.width` - the width of the plane the camera can see
+* :meth:`~yt.visualization.volume_rendering.camera.Camera.focus` - the point in space the camera is looking at
+* :meth:`~yt.visualization.volume_rendering.camera.Camera.resolution` - the image resolution
+* ``north_vector`` - a vector defining the "up" direction in an image
+* :ref:`lens <lenses>` - an object controlling how rays traverse the Scene
.. _camera_movement:
@@ -482,7 +483,7 @@
their combination, are described below.
MPI Parallelization
-+++++++++++++++++++
+^^^^^^^^^^^^^^^^^^^
Currently the volume renderer is parallelized using MPI to decompose the volume
by attempting to split up the
@@ -516,7 +517,7 @@
For more information about enabling parallelism, see :ref:`parallel-computation`.
OpenMP Parallelization
-++++++++++++++++++++++
+^^^^^^^^^^^^^^^^^^^^^^
The volume rendering also parallelized using the OpenMP interface in Cython.
While the MPI parallelization is done using domain decomposition, the OpenMP
@@ -532,7 +533,7 @@
by default by modifying the environment variable OMP_NUM_THREADS.
Running in Hybrid MPI + OpenMP
-++++++++++++++++++++++++++++++
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The two methods for volume rendering parallelization can be used together to
leverage large supercomputing resources. When choosing how to balance the
diff -r 030372da4a869adba281c0c8e301df4416d66c59 -r f140f39046ae28939112fbc616be770b5dec38ef yt/visualization/volume_rendering/render_source.py
--- a/yt/visualization/volume_rendering/render_source.py
+++ b/yt/visualization/volume_rendering/render_source.py
@@ -202,7 +202,8 @@
"""Set the source's fields to render
Parameters
- ---------
+ ----------
+
fields: field name or list of field names
The field or fields to render
no_ghost: boolean
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