[Yt-svn] commit/yt-doc: sskory: Updating examples with correct import statements for Two Point Functions.

[Bitbucket]

1 new changeset in yt-doc:

http://bitbucket.org/yt_analysis/yt-doc/changeset/1e98022cb65a/
changeset:   r37:1e98022cb65a
user:        sskory
date:        2011-03-08 18:43:54
summary:     Updating examples with correct import statements for Two Point Functions.
affected #:  1 file (538 bytes)

--- a/source/analysis_modules/two_point_functions.rst	Mon Mar 07 19:50:16 2011 -0700
+++ b/source/analysis_modules/two_point_functions.rst	Tue Mar 08 10:43:54 2011 -0700
@@ -33,6 +33,7 @@
 .. code-block:: python
 
     from yt.mods import *
+    from yt.analysis_modules.two_point_functions.api import *
     
     pf = load("data0005")
     
@@ -81,6 +82,17 @@
     # The file is named 'rms_vel.h5'.
     tpf.write_out_arrays()
 
+As an aside, note that any analysis function in yt can be accessed directly
+and imported automatically using the ``amods`` construct.
+Here is an abbreviated example:
+
+.. code-block:: python
+
+    from yt.mods import *
+    ...
+    tpf = amods.two_point_functions.TwoPointFunctions(pf, ...)
+
+
 Probability Distribution Function
 ---------------------------------
 
@@ -651,6 +663,7 @@
 .. code-block:: python
 
     from yt.mods import *
+    from yt.analysis_modules.two_point_functions.api import *
     
     pf = load("data0005")
     
@@ -747,6 +760,7 @@
     
     from yt.mods import *
     from yt.utilities.kdtree import *
+    from yt.analysis_modules.two_point_functions.api import *
     
     # Specify the dataset on which we want to base our work.
     pf = load('data0005')
@@ -849,6 +863,7 @@
 
     from yt.mods import *
     from yt.utilities.kdtree import *
+    from yt.analysis_modules.two_point_functions.api import *
     
     # Specify the dataset on which we want to base our work.
     pf = load('data0005')

Repository URL: https://bitbucket.org/yt_analysis/yt-doc/

--

This is a commit notification from bitbucket.org. You are receiving
this because you have the service enabled, addressing the recipient of
this email.