[Yt-svn] yt-commit r784 - in trunk/doc: . build source source/_images source/cookbook source/modules source/modules/reason source/quick_guide source/static source/tutorial

mturk at wrangler.dreamhost.com mturk at wrangler.dreamhost.com
Wed Sep 17 07:56:54 PDT 2008 

Author: mturk
Date: Wed Sep 17 07:56:51 2008
New Revision: 784
URL: http://yt.spacepope.org/changeset/784

Log:
Removed build directory, merged back from the yt-1.0 branch.



Added:
   trunk/doc/docs_html.zip
      - copied unchanged from r783, /branches/yt-1.0/doc/docs_html.zip
   trunk/doc/source/cookbook/plotting_profiles.rst
      - copied unchanged from r783, /branches/yt-1.0/doc/source/cookbook/plotting_profiles.rst
   trunk/doc/source/modules/index.rst
      - copied unchanged from r783, /branches/yt-1.0/doc/source/modules/index.rst
   trunk/doc/source/quick_guide/
      - copied from r783, /branches/yt-1.0/doc/source/quick_guide/
   trunk/doc/source/quick_guide/index.rst
      - copied unchanged from r783, /branches/yt-1.0/doc/source/quick_guide/index.rst
   trunk/doc/source/static/yt_icon.png
      - copied unchanged from r783, /branches/yt-1.0/doc/source/static/yt_icon.png
Removed:
   trunk/doc/build/
Modified:
   trunk/doc/README
   trunk/doc/install_script.sh
   trunk/doc/source/_images/example_3dphase.png
   trunk/doc/source/_images/example_cuttingplane.png
   trunk/doc/source/conf.py
   trunk/doc/source/cookbook/index.rst
   trunk/doc/source/cookbook/making_profiles.rst
   trunk/doc/source/faq.rst
   trunk/doc/source/index.rst
   trunk/doc/source/modules/reason/index.rst
   trunk/doc/source/tutorial/automated_plotting.rst
   trunk/doc/source/tutorial/index.rst
   trunk/doc/source/tutorial/profiles.rst
   trunk/doc/source/tutorial/using_reason.rst
   trunk/doc/wipe_svn.sh

Modified: trunk/doc/README
==============================================================================
--- trunk/doc/README	(original)
+++ trunk/doc/README	Wed Sep 17 07:56:51 2008
@@ -8,3 +8,10 @@
 in the build/ directory, as well as at:
 
 http://yt.enzotools.org/doc/index.html
+
+Additionally, we include pre-generated docs right here for you, inside the zip
+file docs_html.zip.  Just do this, and you get the docs, right here!
+
+unzip docs_html.zip
+
+Then open index.html with your favorite web browser, and be off!

Modified: trunk/doc/install_script.sh
==============================================================================
--- trunk/doc/install_script.sh	(original)
+++ trunk/doc/install_script.sh	Wed Sep 17 07:56:51 2008
@@ -23,8 +23,6 @@
 [ ! -e wxPython-src-2.8.7.1.tar.bz2 ] && wget http://downloads.sourceforge.net/wxpython/wxPython-src-2.8.7.1.tar.bz2
 [ ! -e yt ] && svn co http://svn.enzotools.org/yt/trunk/ ./yt-trunk-svn
 
-
-
 if [ ! -e hdf5-1.6.7/done ]
 then
     [ ! -e hdf5-1.6.7 ] && tar xvfz hdf5-1.6.7.tar.gz
@@ -111,7 +109,6 @@
 touch done
 cd ..
 
-
 echo "yt is now installed in $MY_DIR ."
 echo "To run from this new installation, the a few variables need to be"
 

Modified: trunk/doc/source/_images/example_3dphase.png
==============================================================================
Binary files. No diff available.

Modified: trunk/doc/source/_images/example_cuttingplane.png
==============================================================================
Binary files. No diff available.

Modified: trunk/doc/source/conf.py
==============================================================================
--- trunk/doc/source/conf.py	(original)
+++ trunk/doc/source/conf.py	Wed Sep 17 07:56:51 2008
@@ -48,9 +48,9 @@
 # other places throughout the built documents.
 #
 # The short X.Y version.
-version = '0.3'
+version = '1.0'
 # The full version, including alpha/beta/rc tags.
-release = '0.3-pre'
+release = '1.0'
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -90,7 +90,7 @@
 
 # The name of an image file (within the static path) to place at the top of
 # the sidebar.
-#html_logo = None
+html_logo = "static/yt_icon.png"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

Modified: trunk/doc/source/cookbook/index.rst
==============================================================================
--- trunk/doc/source/cookbook/index.rst	(original)
+++ trunk/doc/source/cookbook/index.rst	Wed Sep 17 07:56:51 2008
@@ -32,6 +32,7 @@
    making_simple_plots
    analyzing_data
    making_profiles
+   plotting_profiles
    grouping_data
    making_movies
    making_timeseries_plots

Modified: trunk/doc/source/cookbook/making_profiles.rst
==============================================================================
--- trunk/doc/source/cookbook/making_profiles.rst	(original)
+++ trunk/doc/source/cookbook/making_profiles.rst	Wed Sep 17 07:56:51 2008
@@ -23,7 +23,7 @@
 In this next example we construct a two-dimensional, weighted-average binning
 of a sphere centered at the point of maximum density in an output.  This sets
 up the basic :class:`BinnedProfile2D` object, which we then add fields to.
-Note that we allow the default weighting to be applied to the Temperature
+Note that we allow the default weighting to be applied to the x-velocity
 field, which will give us an average value, weighted by CellMassMsun.  For the
 second field we add, we explicitly ask to have the values returned to us
 unweighted, which means we are given the distribution of mass along the dimensions

Modified: trunk/doc/source/faq.rst
==============================================================================
--- trunk/doc/source/faq.rst	(original)
+++ trunk/doc/source/faq.rst	Wed Sep 17 07:56:51 2008
@@ -26,6 +26,12 @@
 As far as books go, the only book I've found to be absolutely indispensible is
 the `Beazley Book <http://www.amazon.com/exec/obidos/ASIN/0735710910>`_.
 
+Who works on yt?
+----------------
+
+Matthew Turk is the lead developer, but Jeff Oishi, Britton Smith, Dave Collins
+and Stephen Skory have all made substantive contributions.
+
 What's up with the names?
 -------------------------
 

Modified: trunk/doc/source/index.rst
==============================================================================
--- trunk/doc/source/index.rst	(original)
+++ trunk/doc/source/index.rst	Wed Sep 17 07:56:51 2008
@@ -11,13 +11,12 @@
 
    intro
    getting_started
+   quick_guide/index
    tutorial/index
    cookbook/index
    extending/index
    faq
-   modules/lagos/index
-   modules/raven/index
-   modules/reason/index
+   modules/index
 
 Indices and tables
 ==================

Modified: trunk/doc/source/modules/reason/index.rst
==============================================================================
--- trunk/doc/source/modules/reason/index.rst	(original)
+++ trunk/doc/source/modules/reason/index.rst	Wed Sep 17 07:56:51 2008
@@ -0,0 +1,18 @@
+.. _reason:
+
+yt.reason - wxPython GUI
+========================
+
+When the GUI is onscreen, you can open up a shell to not only interact with the
+data already in existence but to add new data objects.   The one instance of
+ReasonMainWindow is known as *mainwindow* in the namespace of the interpreter.
+
+Additionally, within the namespace of the Reason interpreter, you have access
+to *outputs*, which is a list of the outputs open in the main window, and
+*data_objects*, which is every single derived data object generated in the GUI.
+
+.. currentmodule:: yt.reason
+
+.. autoclass:: yt.reason.ReasonMainWindow
+   :members: add_static_output, add_data_object, add_cutting_wrapper
+   

Modified: trunk/doc/source/tutorial/automated_plotting.rst
==============================================================================
--- trunk/doc/source/tutorial/automated_plotting.rst	(original)
+++ trunk/doc/source/tutorial/automated_plotting.rst	Wed Sep 17 07:56:51 2008
@@ -64,6 +64,8 @@
 
 to get postscript output suitable for publication.
 
+.. _plotcollection_phase_sphere:
+
 More Plots
 ----------
 

Modified: trunk/doc/source/tutorial/index.rst
==============================================================================
--- trunk/doc/source/tutorial/index.rst	(original)
+++ trunk/doc/source/tutorial/index.rst	Wed Sep 17 07:56:51 2008
@@ -1,5 +1,5 @@
-A Short Tutorial
-================
+The Tutorial
+============
 
 As with many interactive packages, getting started with yt can be a bit
 daunting.  Following this tutorial we'll walk through the intepreter, get used

Modified: trunk/doc/source/tutorial/profiles.rst
==============================================================================
--- trunk/doc/source/tutorial/profiles.rst	(original)
+++ trunk/doc/source/tutorial/profiles.rst	Wed Sep 17 07:56:51 2008
@@ -7,6 +7,11 @@
 look at the distribution of Volume through Density and Temperature space.  Or you could
 take the spherically-averaged Number Density and see how it changes with radius.
 
+.. note:: This is all about how to hand-generate profiles.  You probably only
+   want to do this if you're exporting them for plotting elsewhere!  To plot
+   these things, see :ref:`plotcollection_phase_sphere`.
+   
+
 One Dimensional Profiles
 ------------------------
 

Modified: trunk/doc/source/tutorial/using_reason.rst
==============================================================================
--- trunk/doc/source/tutorial/using_reason.rst	(original)
+++ trunk/doc/source/tutorial/using_reason.rst	Wed Sep 17 07:56:51 2008
@@ -10,8 +10,8 @@
 been made to expose a susbtantial API to enable interactive plot addition, as
 well as a command-line for examining raw data.
 
-Starting Reason
----------------
+Starting Up Reason
+------------------
 
 If you've downloaded the binary package for OSX, you can simply double-click
 the icon.  Otherwise, if you have `wxPython <http://www.wxpython.org/>`_
@@ -21,27 +21,81 @@
 When reason starts up, it will execute all the code in your plugin file, so any
 fields you've defined there will be defined in the dialog boxes.
 
-Opening a Dataset
------------------
+Go ahead and open up a dataset now, using the file menu's "Open Hierarchy"
+option.  It'll get added to the tree on the left.  All of its subsequent
+derived data objects -- slices, projections, spheres, etc -- will be added
+there.
 
 .. index:: projection, slice
 
 Making Slices and Projections
 -----------------------------
 
+By right clicking on an output file, you can generate a slice.  The software
+will automatically add a slice for all three axes; with projections, you're
+given more control over the field, weight and axes.
+
+Each created plot will reside in its own tabs; these tabs are linked in their
+display of fields, their width, and their center.  They can be rearranged by
+clicking and dragging -- for instance, multiple panes can be viewed at a single
+time by clicking and dragging to the region you'd like to split into.
+
+These plots can be recentered by getting the context menu on the plot image and
+choosing to either center on the location of the click or to center on the
+location of maximum density.
+
+.. note:: On some platforms, the right-click on a plot in wxPython is
+   non-functional; on these platforms, double-click to pop up the context menu.
+
+Give it a shot; re-center somewhere else.  All of the plots generated at a
+given time will be linked, so they should all re-center on wherever you told
+them to.
+
+.. note:: Even though a projection loses some information, by re-centering on
+   two of the three axes, you can uniquely determine a new center.
+
 .. index:: sphere, EnzoSphere
 
 Obtaining Spheres
 -----------------
 
-Making Cutting Planes
----------------------
+So now we've got a slice through our data, and we've dealt with recentering,
+changing the width and so on.  Now let's try something more advanced.
 
-.. index:: phase plot, cutting plane
+You can generate a sphere by two methods.  The first is to bring up the context
+menu on a plot (either right- or double-click it) and then requesting one.
+This will be centered at the current "plot center" and you can specify the
+width exactly.
 
-Making Phase Plots
-------------------
+Alternatively, you can hold down the *shift* key and click once on the center
+and once on the outer edge.  This will generate a sphere using those two pieces
+of information as the defining characteristics.
+
+This sphere will appear in the object tree as a child of the current plot.
+
+.. index:: phase plot
+
+Making Phase and Profile Plots
+------------------------------
+
+Now that you have a sphere, you are able to make phase and profile plots from
+it.  Right click on it in the object tree and choose to make either a phase
+(two-dimensional) or profile (one-dimensional) plot.
+
+Each of these choices will present you with a constructor window, where you can
+enter the appropriate parameters to define the plot.  Each of these options is
+reflected in the API for the :class:`BinnedProfile1D` and :class:`BinnedProfile2D`
+classes respectively.
+
+.. index:: cutting plane
+
+Making Cutting Planes
+---------------------
 
-Using the Shell
----------------
+Within the GUI, once you have selected a sphere, you can generate a cutting
+plane based on the mass-weighted angular momentum vector of that sphere, and
+centered at its center.  You can access this by right-clicking on a sphere and
+choosing "Cutting Plane."
 
+Additionally, you can overlay a vector plot of the velocity vectors on this
+plot via the context menu.

Modified: trunk/doc/wipe_svn.sh
==============================================================================
--- trunk/doc/wipe_svn.sh	(original)
+++ trunk/doc/wipe_svn.sh	Wed Sep 17 07:56:51 2008
@@ -1,23 +1,21 @@
-for ext in txt html css png js doctree pickle json
-do
-    find build/ -name "*.${ext}" -exec rm -v {} \;
-done
-
-PYTHONPATH=$HOME/Development/yt/trunk/
+export PYTHONPATH=`pwd`/../
 make html
 
 echo "Files deleted since last svn commit:"
 echo " (generated with 'svn stat | grep \! ')"
 echo 
-svn stat | grep \!
+svn stat | grep \! |grep -v build
 echo
 
 echo "Files added since last svn commit:"
 echo " (generated with 'svn stat | grep \? ')"
 echo
-svn stat | grep \?
+svn stat | grep \? | grep -v build/html
 echo
 
 echo "Examples files status:"
 echo
 svn stat ../examples/
+
+cd ./build/html/
+zip -r ../../docs_html.zip .

More information about the yt-svn mailing list