[Yt-svn] yt-commit r659 - in trunk/doc/source: . tutorial

joishi at wrangler.dreamhost.com joishi at wrangler.dreamhost.com
Wed Jul 9 15:31:16 PDT 2008


Author: joishi
Date: Wed Jul  9 15:31:14 2008
New Revision: 659
URL: http://yt.spacepope.org/changeset/659

Log:
* edits for clarity, style, and audience. nothing major, just definitions of some terms, etc.


Modified:
   trunk/doc/source/getting_started.rst
   trunk/doc/source/intro.rst
   trunk/doc/source/tutorial/automated_plotting.rst
   trunk/doc/source/tutorial/basic_objects.rst
   trunk/doc/source/tutorial/derived_fields.rst
   trunk/doc/source/tutorial/profiles.rst

Modified: trunk/doc/source/getting_started.rst
==============================================================================
--- trunk/doc/source/getting_started.rst	(original)
+++ trunk/doc/source/getting_started.rst	Wed Jul  9 15:31:14 2008
@@ -62,16 +62,16 @@
  * `wxPython <http://www.wxpython.org/>`_, the GUI toolkit
 
 (If you are only interested in manipulating data without any graphical plotting
-or interfaces, you only need to install NumPy and Python!)
+or interfaces, you only need to install HDF5, NumPy, and Python!)
 
 Installing the Necessary Packages
 ---------------------------------
 
-.. note::
-   In the ``doc/`` directory in the yt source distribution, there is a script I
-   have used in the past to set up a full installation of yt.  It may need
-   tweaking or modification, but it gives a good idea of the roadmap to
-   installation.
+.. note:: 
+   In the ``doc/`` directory in the yt source distribution, there is a script,
+   ``install_script.sh``, that I have used in the past to set up a full
+   installation of yt.  It may need tweaking or modification, but it gives a
+   good idea of the roadmap to installation.
 
 Installing Python itself is usually quite simple, and often very fast.  Because
 we're setting up a small system of packages, even if you have a system-wide

Modified: trunk/doc/source/intro.rst
==============================================================================
--- trunk/doc/source/intro.rst	(original)
+++ trunk/doc/source/intro.rst	Wed Jul  9 15:31:14 2008
@@ -19,9 +19,9 @@
 the data as they desire.
 
 Originally, yt was written as a frontend to HippoDraw, an extensible and
-comprehensive plotting package built at SLAC by Paul Kunz.  Over time, however,
-it has been generalized to rely on mostly commodity Python packages, and its
-dependencies reduced and ease of installation increased.
+comprehensive plotting package built at SLAC by Paul Kunz.  Over time
+it has been generalized to rely on commodity Python packages (mostly), its
+dependencies have been reduced, and thus its installation made significantly easier.
 
 What yt is and is not
 ---------------------
@@ -58,7 +58,7 @@
 
   * Arbitrary field definition
   * Derived quantities (average values, spin parameter, bulk velocity, etc)
-  * Fast-HDF5 backend for packed and unpacked AMR, NumPy-based HDF4 backend
+  * Custom C- written HDF5 backend for packed and unpacked AMR, NumPy-based HDF4 backend
   * CGS units used everywhere
   * Per-user field and quantity plugins
 
@@ -67,7 +67,7 @@
   * Mathtext TeX-like text formatting
   * Slices, projections, oblique slices
   * Profiles and phase diagrams
-  * Linked zooms, colormaps, and saving
+  * Linked zooms, colormaps, and saving across multiple plots
   * Contours, vector plots, annotated boxes, grid boundary plot overlays.
   * Simple 3D plotting of phase plots and volume-rendered boxes via hooks into the S2PLOT library
 

Modified: trunk/doc/source/tutorial/automated_plotting.rst
==============================================================================
--- trunk/doc/source/tutorial/automated_plotting.rst	(original)
+++ trunk/doc/source/tutorial/automated_plotting.rst	Wed Jul  9 15:31:14 2008
@@ -44,11 +44,15 @@
 
    >>> print pc.plots[1].data
 
-After we've created the plots above, we set the width to 15 kiloparsecs.
-Note that raven understands any length unit that the hierarchy has, so you
-can set to mpc, kpc, pc, au, km or cm.  Then we call save, and feed it a prefix --
-it takes care of adding some more information to the filename, so don't supply it
-a file suffix.  (It defaults to '.png')
+After we've created the plots above, we set the width to 15 kiloparsecs.  Note
+that raven understands any length unit that the hierarchy has, so you can set to
+mpc, kpc, pc, au, km or cm.  Then we call save, and feed it a prefix -- it takes
+care of adding some more information to the filename, so don't supply it a file
+suffix. pc.save defaults to '.png', but a "format" keyword can be supplied::
+
+   >>> pc.save("somename_15kpc",format='ps')
+
+to get postscript output suitable for publication.
 
 More Plots
 ----------

Modified: trunk/doc/source/tutorial/basic_objects.rst
==============================================================================
--- trunk/doc/source/tutorial/basic_objects.rst	(original)
+++ trunk/doc/source/tutorial/basic_objects.rst	Wed Jul  9 15:31:14 2008
@@ -15,7 +15,8 @@
 
    >>> print lagos.fieldInfo["Entropy"].get_source()
 
-But what if we only want a couple values?  We can directly grab indices.  ::
+But what if we only want a couple values?  We can directly grab indices, in C
+order.  ::
 
    >>> print my_grid["Density"][0,10,4] # 0-indexed!
 
@@ -62,7 +63,7 @@
 Boxes
 -----
 
-Let's do a region.  This is a box with a left edge and a right edge, and a
+Let's do a region.  A region is a box with a left edge and a right edge, and a
 center.  (You need a center for some other calculations, not for getting the
 region.)  Let's get started by grabbing the ENTIRE domain.::
 

Modified: trunk/doc/source/tutorial/derived_fields.rst
==============================================================================
--- trunk/doc/source/tutorial/derived_fields.rst	(original)
+++ trunk/doc/source/tutorial/derived_fields.rst	Wed Jul  9 15:31:14 2008
@@ -38,9 +38,10 @@
 three main parts.  The first is the function that defines the field.  It always
 accepts two variables -- field, and data.  'Field' is the DerivedField and
 'data' is the data object.  Note that we stick to a pretty strict means of
-returning fields -- *everything is returned in cgs*!  This means that when
-we request "Density" from 'data' it is returned to us *already* in CGS, so we
-don't need to convert anything.
+returning fields -- *everything is returned in cgs*!  This means that when we
+request "Density" from 'data' it is returned to us *already* in CGS, so we don't
+need to convert the units. This may not always be the case for derived fields,
+so the second function defines the necessary unit conversion.
 
 More Complicated Fields
 -----------------------

Modified: trunk/doc/source/tutorial/profiles.rst
==============================================================================
--- trunk/doc/source/tutorial/profiles.rst	(original)
+++ trunk/doc/source/tutorial/profiles.rst	Wed Jul  9 15:31:14 2008
@@ -4,7 +4,7 @@
 Profiles are one of the more interesting data types.  They are a binned average
 of one or more variables, along one, two or three different dimensions.  For example,
 you could get an average temperature in Density and H2 Fraction space.  Or you could
-Look at the distribution of Volume through Density and Temperature space.  Or you could
+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.
 
 One Dimensional Profiles
@@ -61,20 +61,21 @@
    >>> pylab.pcolormesh(prof2d["Density"], prof2d["Temperature"],
    ...                  prof2d["CellVolume"].transpose())
 
-Again, we have manually plotted this, but an automated plotter is available.::
+Again, we have manually plotted this, but an automated plotter is available vi
+:mod:`raven`::
 
    >>> pc = raven.PlotCollection(a)
    >>> pc.add_phase_object(sphere, ["Density", "Temperature", "x-velocity"],
    ...                 16, True, (1e-32, 1e-24), 
    ...                 16, True, (1e2, 1e5), lazy_reader=True)
 
-The API is slightly different here, but it will accept any object (a sphere in
-our case) and generate the profile based on the arguments.  If you simply want
-a sphere, you can ask for that and the sphere will be generated as well -- and
-the function will automatically generate the bounds.  (Although, keep in mind,
-if you do not supply bounds it will have to read the data into memory, which
-means you are no longer able to use the :keyword:`lazy_reader` functionality.
-This will change in future versions.) ::
+The yt API is slightly different here, but it will accept any object (a sphere
+in our case) and generate the profile based on the arguments.  If you simply
+want a sphere, you can ask for that and the sphere will be generated as well --
+and the function will automatically generate the bounds.  (Although, keep in
+mind, if you do not supply bounds it will have to read the data into memory,
+which means you are no longer able to use the :keyword:`lazy_reader`
+functionality.  This will change in future versions.) ::
 
 
    >>> pc.add_phase_sphere(0.1, 'kpc', ["Density", "Temperature", "x-velocity"])
@@ -107,8 +108,8 @@
 
 They can be generated anywhere -- and serialized -- so if you want to generate
 them on a remote machine and use a local-machine for display, you only have to
-call :func:`store` and then initialize, instead of the standard
-:class:`BinnedProfile3D`, :class:`StoredBinnedProfile3D`.  ::
+call :func:`store` and then initialize using :class:`StoredBinnedProfile3D`,
+instead of the standard :class:`BinnedProfile3D`.  ::
 
    >>> prof.store_profile('MyProfile')
    >>> new_prof = lagos.StoredBinnedProfile3D(a, 'MyProfile')



More information about the yt-svn mailing list