[yt-svn] commit/yt: ngoldbaum: Merged in atmyers/yt (pull request #2311)
commits-noreply at bitbucket.org
commits-noreply at bitbucket.org
Fri Jul 29 13:30:13 PDT 2016
1 new commit in yt:
https://bitbucket.org/yt_analysis/yt/commits/bdc1201a3c1b/
Changeset: bdc1201a3c1b
Branch: yt
User: ngoldbaum
Date: 2016-07-29 20:29:42+00:00
Summary: Merged in atmyers/yt (pull request #2311)
[DOCS] Update the Embree installation instructions to make it clear that it is optional.
Affected #: 2 files
diff -r bed1c7427f07fb15454e9410164d4b3d09338bc1 -r bdc1201a3c1b9c07a269452d9b4dbeea8c4f0965 doc/install_script.sh
--- a/doc/install_script.sh
+++ b/doc/install_script.sh
@@ -49,8 +49,8 @@
# in Python 3 (except Mercurial, which requires Python 2).
INST_HG=1 # Install Mercurial or not? If hg is not already
# installed, yt cannot be installed from source.
-INST_UNSTRUCTURED=0 # Install dependencies needed for unstructured mesh
- # rendering?
+INST_EMBREE=0 # Install dependencies needed for Embree-accelerated
+ # ray tracing
# These options control whether low-level system libraries are installed
# they are necessary for building yt's dependencies from source and are
@@ -75,6 +75,7 @@
INST_H5PY=1 # Install h5py?
INST_ASTROPY=0 # Install astropy?
INST_NOSE=1 # Install nose?
+INST_NETCDF4=0 # Install netcdf4 and its python bindings?
# These options allow you to customize the builds of yt dependencies.
# They are only used if INST_CONDA=0.
@@ -484,21 +485,19 @@
( $* 2>&1 ) 1>> ${LOG_FILE} || do_exit
}
-# set paths needed for unstructured mesh rendering support
+# set paths needed for Embree
-if [ $INST_UNSTRUCTURED -ne 0 ]
+if [ $INST_EMBREE -ne 0 ]
then
if [ $INST_YT_SOURCE -eq 0 ]
then
- echo "yt must be compiled from source to install support for"
- echo "unstructured mesh rendering. Please set INST_YT_SOURCE to 1"
- echo "and re-run the install script."
+ echo "yt must be compiled from source to install Embree support."
+ echo "Please set INST_YT_SOURCE to 1 and re-run the install script."
exit 1
fi
if [ $INST_CONDA -eq 0 ]
then
- echo "unstructured mesh rendering support has not yet been implemented"
- echo "for INST_CONDA=0."
+ echo "Embree support has not yet been implemented for INST_CONDA=0."
exit 1
fi
if [ `uname` = "Darwin" ]
@@ -510,8 +509,8 @@
EMBREE="embree-2.8.0.x86_64.linux"
EMBREE_URL="https://github.com/embree/embree/releases/download/v2.8.0/$EMBREE.tar.gz"
else
- echo "Unstructured mesh rendering is not supported on this platform."
- echo "Set INST_UNSTRUCTURED=0 and re-run the install script."
+ echo "Embree is not supported on this platform."
+ echo "Set INST_EMBREE=0 and re-run the install script."
exit 1
fi
PYEMBREE_URL="https://github.com/scopatz/pyembree/archive/master.zip"
@@ -528,6 +527,17 @@
fi
fi
+if [ $INST_NETCDF4 -ne 0 ]
+then
+ if [ $INST_CONDA -eq 0 ]
+ then
+ echo "This script can only install netcdf4 through conda."
+ echo "Please set INST_CONDA to 1"
+ echo "and re-run the install script"
+ exit 1
+ fi
+fi
+
echo
echo
echo "========================================================================"
@@ -557,9 +567,9 @@
get_willwont ${INST_HG}
echo "be installing Mercurial"
-printf "%-18s = %s so I " "INST_UNSTRUCTURED" "${INST_UNSTRUCTURED}"
-get_willwont ${INST_UNSTRUCTURED}
-echo "be installing unstructured mesh rendering"
+printf "%-18s = %s so I " "INST_EMBREE" "${INST_EMBREE}"
+get_willwont ${INST_EMBREE}
+echo "be installing Embree"
if [ $INST_CONDA -eq 0 ]
then
@@ -1411,7 +1421,7 @@
fi
YT_DEPS+=('sympy')
- if [ $INST_UNSTRUCTURED -eq 1 ]
+ if [ $INST_NETCDF4 -eq 1 ]
then
YT_DEPS+=('netcdf4')
fi
@@ -1436,10 +1446,10 @@
log_cmd hg clone https://bitbucket.org/yt_analysis/yt_conda ${DEST_DIR}/src/yt_conda
- if [ $INST_UNSTRUCTURED -eq 1 ]
+ if [ $INST_EMBREE -eq 1 ]
then
- echo "Installing embree"
+ echo "Installing Embree"
if [ ! -d ${DEST_DIR}/src ]
then
mkdir ${DEST_DIR}/src
@@ -1494,7 +1504,7 @@
echo "Building yt from source"
YT_DIR="${DEST_DIR}/src/yt-hg"
log_cmd hg clone -r ${BRANCH} https://bitbucket.org/yt_analysis/yt ${YT_DIR}
- if [ $INST_UNSTRUCTURED -eq 1 ]
+ if [ $INST_EMBREE -eq 1 ]
then
echo $DEST_DIR > ${YT_DIR}/embree.cfg
fi
diff -r bed1c7427f07fb15454e9410164d4b3d09338bc1 -r bdc1201a3c1b9c07a269452d9b4dbeea8c4f0965 doc/source/visualizing/unstructured_mesh_rendering.rst
--- a/doc/source/visualizing/unstructured_mesh_rendering.rst
+++ b/doc/source/visualizing/unstructured_mesh_rendering.rst
@@ -3,40 +3,46 @@
Unstructured Mesh Rendering
===========================
-Installation
-^^^^^^^^^^^^
+Beginning with version 3.3, yt has the ability to volume render unstructured
+mesh data like that created by finite element calculations. No additional
+dependencies are required in order to use this feature. However, it is
+possible to speed up the rendering operation by installing with
+`Embree <https://embree.github.io>`_ support. Embree is a fast ray-tracing
+library from Intel that can substantially speed up the mesh rendering operation
+on large datasets. You can read about how to install yt with Embree support
+below, or you can skip to the examples.
-Beginning with version 3.3, yt has the ability to volume render unstructured
-mesh data like that created by finite element calculations. In order to use
-this capability, a few additional dependencies are required. The easiest way
-to install yt with unstructured mesh support is to use conda to install the
+Optional Embree Installation
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The easiest way to install yt with Embree support is to use conda to install the
most recent development version of yt from our channel:
.. code-block:: bash
conda install -c http://use.yt/with_conda/ yt
-If you want to install from source, you can use the ``get_yt.sh`` script.
-Be sure to set the INST_YT_SOURCE and INST_UNSTRUCTURED flags to 1 at the
-top of the script. The ``get_yt.sh`` script can be downloaded by doing:
+Alternatively, you can install yt from source using the ``install_script.sh``
+script. Be sure to set the INST_CONDA, INST_YT_SOURCE, INST_EMBREE,
+and INST_NETCDF4 flags to 1 at the top of the script. The ``install_script.sh``
+script can be downloaded by doing:
.. code-block:: bash
- wget http://bitbucket.org/yt_analysis/yt/raw/yt/doc/get_yt.sh
+ wget http://bitbucket.org/yt_analysis/yt/raw/yt/doc/install_script.sh
and then run like so:
.. code-block:: bash
- bash get_yt.sh
+ bash install_script.sh
-Alternatively, you can install the additional dependencies by hand.
-First, `embree <https://embree.github.io>`_
-(a fast software ray-tracing library from Intel) must be installed, either
-by compiling from source or by using one of the pre-built binaries available
-at Embree's `downloads <https://embree.github.io/downloads.html>`_ page.
+Finally, you can install the additional dependencies by hand.
+First, you will need to install Embree, either by compiling from source
+or by using one of the pre-built binaries available at Embree's
+`downloads <https://embree.github.io/downloads.html>`_ page.
-Second, the python bindings for embree (called
+Second, the python bindings for Embree (called
`pyembree <https://github.com/scopatz/pyembree>`_) must also be installed. To
do so, first obtain a copy, by .e.g. cloning the repo:
@@ -54,7 +60,7 @@
CFLAGS='-I/opt/local/include' LDFLAGS='-L/opt/local/lib' python setup.py install
-Once embree and pyembree are installed, you must rebuild yt from source in order to use
+Once Embree and pyembree are installed, you must rebuild yt from source in order to use
the unstructured mesh rendering capability. Once again, if embree is installed in a
location that is not part of your default search path, you must tell yt where to find it.
There are a number of ways to do this. One way is to again manually pass in the flags
@@ -84,20 +90,6 @@
neccessary if you installed embree into a location that is in your default path, such
as /usr/local.
-Once the pre-requisites are installed, unstructured mesh data can be rendered
-much like any other dataset. In particular, a new type of
-:class:`~yt.visualization.volume_rendering.render_source.RenderSource` object
-has been defined, called the
-:class:`~yt.visualization.volume_rendering.render_source.MeshSource`, that
-represents the unstructured mesh data that will be rendered. The user creates
-this object, and also defines a
-:class:`~yt.visualization.volume_rendering.camera.Camera`
-that specifies your viewpoint into the scene. When
-:class:`~yt.visualization.volume_rendering.render_source.RenderSource` is called,
-a set of rays are cast at the source. Each time a ray strikes the source mesh,
-the data is sampled at the intersection point at the resulting value gets
-saved into an image. See below for examples.
-
Examples
^^^^^^^^
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