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

[mturk at wrangler.dreamhost.com]

Author: mturk
Date: Sun Jul 13 22:06:17 2008
New Revision: 664
URL: http://yt.spacepope.org/changeset/664

Log:
Some minor changes -- adding the reason part to the tutorial, even if it's
mostly empty, and moving around some installation script info.



Added:
   trunk/doc/source/tutorial/using_reason.rst
Modified:
   trunk/doc/source/getting_started.rst
   trunk/doc/source/index.rst
   trunk/doc/source/tutorial/index.rst

Modified: trunk/doc/source/getting_started.rst
==============================================================================
--- trunk/doc/source/getting_started.rst	(original)
+++ trunk/doc/source/getting_started.rst	Sun Jul 13 22:06:17 2008
@@ -46,6 +46,15 @@
 Installing From Source
 ======================
 
+Using the Installation Script
+-----------------------------
+
+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.
+
+
 Prerequisites for yt
 --------------------
 
@@ -67,12 +76,6 @@
 Installing the Necessary Packages
 ---------------------------------
 
-.. 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
 install of python2.5 it can be easier in some cases to create a local directory

Modified: trunk/doc/source/index.rst
==============================================================================
--- trunk/doc/source/index.rst	(original)
+++ trunk/doc/source/index.rst	Sun Jul 13 22:06:17 2008
@@ -25,4 +25,3 @@
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-

Modified: trunk/doc/source/tutorial/index.rst
==============================================================================
--- trunk/doc/source/tutorial/index.rst	(original)
+++ trunk/doc/source/tutorial/index.rst	Sun Jul 13 22:06:17 2008
@@ -19,3 +19,4 @@
    advanced_objects
    projections
    example_script
+   using_reason

Added: trunk/doc/source/tutorial/using_reason.rst
==============================================================================
--- (empty file)
+++ trunk/doc/source/tutorial/using_reason.rst	Sun Jul 13 22:06:17 2008
@@ -0,0 +1,47 @@
+.. index::
+   single: GUI
+   module: reason
+   module: yt.reason
+
+Using Reason
+============
+
+Reason is the GUI for yt.  It's developed in wxPython, and all attempts have
+been made to expose a susbtantial API to enable interactive plot addition, as
+well as a command-line for examining raw data.
+
+Starting 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/>`_
+installed, and yt is installed globally, you should be able to simply type
+``reason`` to initiate it.
+
+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
+-----------------
+
+.. index:: projection, slice
+
+Making Slices and Projections
+-----------------------------
+
+.. index:: sphere, EnzoSphere
+
+Obtaining Spheres
+-----------------
+
+Making Cutting Planes
+---------------------
+
+.. index:: phase plot, cutting plane
+
+Making Phase Plots
+------------------
+
+Using the Shell
+---------------
+