[yt-svn] commit/yt-doc: 5 new changesets
Bitbucket
commits-noreply at bitbucket.org
Sat Jul 7 14:00:20 PDT 2012
5 new commits in yt-doc:
https://bitbucket.org/yt_analysis/yt-doc/changeset/db17efde9edb/
changeset: db17efde9edb
user: MatthewTurk
date: 2012-07-07 13:34:30
summary: This doesn't add anything to the _static directory (since we might swap out for
SlicePlot and ProjectionPlot) but it does update the index appearance.
affected #: 4 files
diff -r dd80a359d8b64da7bb686f6580ec9e9f792588d1 -r db17efde9edb2f4a225cf91ad7745e0ccd5c2904 source/cookbook/average_value.py
--- a/source/cookbook/average_value.py
+++ b/source/cookbook/average_value.py
@@ -1,14 +1,13 @@
from yt.mods import *
-pf = load("RedshiftOutput0005") # load data
+pf = load("IsolatedGalaxy/galaxy0030/galaxy0030") # load data
field = "Temperature" # The field to average
weight = "CellMassMsun" # The weight for the average
dd = pf.h.all_data() # This is a region describing the entire box,
- # but note it doesn't read anything in yet!
+ # but note it doesn't read anything in yet!
# We now use our 'quantities' call to get the average quantity
-average_value = dd.quantities["WeightedAverageQuantity"](
- field, weight, lazy_reader=True)
+average_value = dd.quantities["WeightedAverageQuantity"](field, weight)
print "Average %s (weighted by %s) is %0.5e" % (field, weight, average_value)
diff -r dd80a359d8b64da7bb686f6580ec9e9f792588d1 -r db17efde9edb2f4a225cf91ad7745e0ccd5c2904 source/cookbook/boolean_data_objects.py
--- a/source/cookbook/boolean_data_objects.py
+++ b/source/cookbook/boolean_data_objects.py
@@ -6,7 +6,7 @@
"""
from yt.mods import * # set up our namespace
-pf = load("RedshiftOutput0005") # load data
+pf = load("Enzo_64/DD0043/data0043") # load data
# Make a few data ojbects to start.
re1 = pf.h.region([0.5, 0.5, 0.5], [0.4, 0.4, 0.4], [0.6, 0.6, 0.6])
re2 = pf.h.region([0.5, 0.5, 0.5], [0.5, 0.5, 0.5], [0.6, 0.6, 0.6])
diff -r dd80a359d8b64da7bb686f6580ec9e9f792588d1 -r db17efde9edb2f4a225cf91ad7745e0ccd5c2904 source/cookbook/contours_on_slice.py
--- a/source/cookbook/contours_on_slice.py
+++ b/source/cookbook/contours_on_slice.py
@@ -4,11 +4,9 @@
"""
from yt.mods import * # set up our namespace
-fn = "RedshiftOutput0005" # parameter file to load
-
-pf = load(fn) # load data
-pc = PlotCollection(pf) # defaults to center at most dense point
+pf = load("GasSloshing/sloshing_nomag2_hdf5_plt_cnt_0150") # load data
+pc = PlotCollection(pf, 'c') # Center at domain center
p = pc.add_slice("Density", 0) # 0 = x-axis
p.modify["contour"]("Temperature")
-pc.set_width(1.5, 'mpc') # change width of all plots in pc
+pc.set_width(1.0, 'unitary') # change width of all plots in pc
pc.save(fn) # save all plots
diff -r dd80a359d8b64da7bb686f6580ec9e9f792588d1 -r db17efde9edb2f4a225cf91ad7745e0ccd5c2904 source/cookbook/index.rst
--- a/source/cookbook/index.rst
+++ b/source/cookbook/index.rst
@@ -14,9 +14,11 @@
page. This includes FLASH and Enzo datasets, both of which are in evidence
here.
+If you want to take a look at more complex recipes, or submit your own,
+check out the `yt Hub <http://hub.yt-project.org>`_.
+
.. note::
- If you want to take a look at more complex recipes, or submit your own,
- check out the `yt Hub <http://hub.yt-project.org>`.
+ To view at full size, right click on an image and choose "Open in New Tab."
.. contents::
:depth: 1
@@ -34,6 +36,14 @@
.. literalinclude:: simple_slice.py
+.. image:: _static/simple_slice_sloshing_nomag2_hdf5_plt_cnt_0150_Slice_x_Density.png
+ :width: 250
+
+.. image:: _static/simple_slice_sloshing_nomag2_hdf5_plt_cnt_0150_Slice_y_Density.png
+ :width: 250
+
+.. image:: _static/simple_slice_sloshing_nomag2_hdf5_plt_cnt_0150_Slice_z_Density.png
+ :width: 250
Simple Probability Distribution Functions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -44,6 +54,9 @@
.. literalinclude:: simple_pdf.py
+.. image:: _static/simple_pdf_fiducial_1to3_b0.273d_hdf5_plt_cnt_0175_Profile2D_0_Density_Temperature_CellMassMsun.png
+ :width: 250
+
Simple Phase Plots
~~~~~~~~~~~~~~~~~~
@@ -53,6 +66,9 @@
.. literalinclude:: simple_phase.py
+.. image:: _static/simple_phase_galaxy0030_Profile2D_0_Density_Temperature_CellMassMsun.png
+ :width: 250
+
Simple 1D Histograms
~~~~~~~~~~~~~~~~~~~~
@@ -62,6 +78,9 @@
.. literalinclude:: simple_profile.py
+.. image:: _static/simple_profile_galaxy0030_Profile1D_0_Density_Temperature.png
+ :width: 250
+
Simple Projections
~~~~~~~~~~~~~~~~~~
@@ -69,6 +88,15 @@
.. literalinclude:: simple_projection.py
+.. image:: _static/simple_projection_fiducial_1to3_b0.273d_hdf5_plt_cnt_0175_Projection_x_Density_Density.png
+ :width: 250
+
+.. image:: _static/simple_projection_fiducial_1to3_b0.273d_hdf5_plt_cnt_0175_Projection_y_Density_Density.png
+ :width: 250
+
+.. image:: _static/simple_projection_fiducial_1to3_b0.273d_hdf5_plt_cnt_0175_Projection_z_Density_Density.png
+ :width: 250
+
Simple Radial Profiles
~~~~~~~~~~~~~~~~~~~~~~
@@ -77,6 +105,9 @@
.. literalinclude:: simple_radial_profile.py
+.. image:: _static/simple_radial_profile_galaxy0030_Profile1D_0_RadiusMpc_Density.png
+ :width: 250
+
Simple Volume Rendering
~~~~~~~~~~~~~~~~~~~~~~~
@@ -85,6 +116,9 @@
.. literalinclude:: simple_volume_rendering.py
+.. image:: _static/simple_volume_rendering_data0043_volume_rendered.png
+ :width: 250
+
Off-Axis Slicing
~~~~~~~~~~~~~~~~
https://bitbucket.org/yt_analysis/yt-doc/changeset/f3477f45d94a/
changeset: f3477f45d94a
user: MatthewTurk
date: 2012-07-07 13:38:07
summary: Splitting up the cookbook into multiple pages.
affected #: 6 files
diff -r db17efde9edb2f4a225cf91ad7745e0ccd5c2904 -r f3477f45d94a3fdf2878ca004329f96290c7e4c8 source/cookbook/calculating_information.rst
--- /dev/null
+++ b/source/cookbook/calculating_information.rst
@@ -0,0 +1,7 @@
+Calculating Dataset Information
+-------------------------------
+
+.. literalinclude:: average_value.py
+.. literalinclude:: sum_mass_in_sphere.py
+.. literalinclude:: global_phase_plots.py
+
diff -r db17efde9edb2f4a225cf91ad7745e0ccd5c2904 -r f3477f45d94a3fdf2878ca004329f96290c7e4c8 source/cookbook/complex_plots.rst
--- /dev/null
+++ b/source/cookbook/complex_plots.rst
@@ -0,0 +1,10 @@
+A Few Complex Plots
+-------------------
+
+.. literalinclude:: offaxis_projection.py
+.. literalinclude:: multi_width_image.py
+.. literalinclude:: overplot_particles.py
+.. literalinclude:: thin_slice_projection.py
+.. literalinclude:: velocity_vectors_on_slice.py
+.. literalinclude:: contours_on_slice.py
+
diff -r db17efde9edb2f4a225cf91ad7745e0ccd5c2904 -r f3477f45d94a3fdf2878ca004329f96290c7e4c8 source/cookbook/constructing_data_objects.rst
--- /dev/null
+++ b/source/cookbook/constructing_data_objects.rst
@@ -0,0 +1,6 @@
+Constructing Data Objects
+-------------------------
+
+.. literalinclude:: find_clumps.py
+.. literalinclude:: boolean_data_objects.py
+
diff -r db17efde9edb2f4a225cf91ad7745e0ccd5c2904 -r f3477f45d94a3fdf2878ca004329f96290c7e4c8 source/cookbook/cosmological_analysis.rst
--- /dev/null
+++ b/source/cookbook/cosmological_analysis.rst
@@ -0,0 +1,9 @@
+Cosmological Analysis
+---------------------
+
+.. literalinclude:: make_light_cone.py
+.. literalinclude:: make_light_ray.py
+.. literalinclude:: halo_finding.py
+.. literalinclude:: halo_particle_plotting.py
+.. literalinclude:: halo_plotting.py
+
diff -r db17efde9edb2f4a225cf91ad7745e0ccd5c2904 -r f3477f45d94a3fdf2878ca004329f96290c7e4c8 source/cookbook/index.rst
--- a/source/cookbook/index.rst
+++ b/source/cookbook/index.rst
@@ -20,142 +20,12 @@
.. note::
To view at full size, right click on an image and choose "Open in New Tab."
-.. contents::
- :depth: 1
- :local:
- :backlinks: none
+.. toctree::
+ :maxdepth: 2
-Making Simple Plots
--------------------
+ simple_plots
+ calculating_information
+ complex_plots
+ cosmological_analysis
+ constructing_data_objects
-Simple Slices
-~~~~~~~~~~~~~
-
-This script shows the simplest way to make a slice from the scripting
-interface.
-
-.. literalinclude:: simple_slice.py
-
-.. image:: _static/simple_slice_sloshing_nomag2_hdf5_plt_cnt_0150_Slice_x_Density.png
- :width: 250
-
-.. image:: _static/simple_slice_sloshing_nomag2_hdf5_plt_cnt_0150_Slice_y_Density.png
- :width: 250
-
-.. image:: _static/simple_slice_sloshing_nomag2_hdf5_plt_cnt_0150_Slice_z_Density.png
- :width: 250
-
-Simple Probability Distribution Functions
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Often, one wants to examine the distribution of one variable as a function of
-another. This shows how to see the distribution of mass in a simulation, with
-respect to the total mass in the simulation.
-
-.. literalinclude:: simple_pdf.py
-
-.. image:: _static/simple_pdf_fiducial_1to3_b0.273d_hdf5_plt_cnt_0175_Profile2D_0_Density_Temperature_CellMassMsun.png
- :width: 250
-
-Simple Phase Plots
-~~~~~~~~~~~~~~~~~~
-
-This demonstrates how to make a phase plot. Phase plots can be thought of as
-two-dimensional histograms, where the value is either the weighted-average or
-the total accumualtion in a cell.
-
-.. literalinclude:: simple_phase.py
-
-.. image:: _static/simple_phase_galaxy0030_Profile2D_0_Density_Temperature_CellMassMsun.png
- :width: 250
-
-Simple 1D Histograms
-~~~~~~~~~~~~~~~~~~~~
-
-This is a "profile," which is a 1D profile. This can be thought of as either
-the total accumulation (when weight is set to ``None``) or the average (when a
-weight is supplied.)
-
-.. literalinclude:: simple_profile.py
-
-.. image:: _static/simple_profile_galaxy0030_Profile1D_0_Density_Temperature.png
- :width: 250
-
-Simple Projections
-~~~~~~~~~~~~~~~~~~
-
-This is the simplest way to make a projection through a dataset.
-
-.. literalinclude:: simple_projection.py
-
-.. image:: _static/simple_projection_fiducial_1to3_b0.273d_hdf5_plt_cnt_0175_Projection_x_Density_Density.png
- :width: 250
-
-.. image:: _static/simple_projection_fiducial_1to3_b0.273d_hdf5_plt_cnt_0175_Projection_y_Density_Density.png
- :width: 250
-
-.. image:: _static/simple_projection_fiducial_1to3_b0.273d_hdf5_plt_cnt_0175_Projection_z_Density_Density.png
- :width: 250
-
-Simple Radial Profiles
-~~~~~~~~~~~~~~~~~~~~~~
-
-This shows how to make a profile of a quantity with respect to the radius, in
-this case the radius in Mpc.
-
-.. literalinclude:: simple_radial_profile.py
-
-.. image:: _static/simple_radial_profile_galaxy0030_Profile1D_0_RadiusMpc_Density.png
- :width: 250
-
-Simple Volume Rendering
-~~~~~~~~~~~~~~~~~~~~~~~
-
-Here we see how to make a very simple volume rendering, where each option is
-considered in turn.
-
-.. literalinclude:: simple_volume_rendering.py
-
-.. image:: _static/simple_volume_rendering_data0043_volume_rendered.png
- :width: 250
-
-Off-Axis Slicing
-~~~~~~~~~~~~~~~~
-
-A cutting plane allows you to slice at some angle that isn't aligned with the
-axes.
-
-.. literalinclude:: aligned_cutting_plane.py
-
-Calculating Dataset Information
--------------------------------
-
-.. literalinclude:: average_value.py
-.. literalinclude:: sum_mass_in_sphere.py
-.. literalinclude:: global_phase_plots.py
-
-A Few Complex Plots
--------------------
-
-.. literalinclude:: offaxis_projection.py
-.. literalinclude:: multi_width_image.py
-.. literalinclude:: overplot_particles.py
-.. literalinclude:: thin_slice_projection.py
-.. literalinclude:: velocity_vectors_on_slice.py
-.. literalinclude:: contours_on_slice.py
-
-Cosmological Analysis
----------------------
-
-.. literalinclude:: make_light_cone.py
-.. literalinclude:: make_light_ray.py
-.. literalinclude:: halo_finding.py
-.. literalinclude:: halo_particle_plotting.py
-.. literalinclude:: halo_plotting.py
-
-Constructing Data Objects
--------------------------
-
-.. literalinclude:: find_clumps.py
-.. literalinclude:: boolean_data_objects.py
-
diff -r db17efde9edb2f4a225cf91ad7745e0ccd5c2904 -r f3477f45d94a3fdf2878ca004329f96290c7e4c8 source/cookbook/simple_plots.rst
--- /dev/null
+++ b/source/cookbook/simple_plots.rst
@@ -0,0 +1,102 @@
+Making Simple Plots
+-------------------
+
+Simple Slices
+~~~~~~~~~~~~~
+
+This script shows the simplest way to make a slice from the scripting
+interface.
+
+.. literalinclude:: simple_slice.py
+
+.. image:: _static/simple_slice_sloshing_nomag2_hdf5_plt_cnt_0150_Slice_x_Density.png
+ :width: 250
+
+.. image:: _static/simple_slice_sloshing_nomag2_hdf5_plt_cnt_0150_Slice_y_Density.png
+ :width: 250
+
+.. image:: _static/simple_slice_sloshing_nomag2_hdf5_plt_cnt_0150_Slice_z_Density.png
+ :width: 250
+
+Simple Probability Distribution Functions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Often, one wants to examine the distribution of one variable as a function of
+another. This shows how to see the distribution of mass in a simulation, with
+respect to the total mass in the simulation.
+
+.. literalinclude:: simple_pdf.py
+
+.. image:: _static/simple_pdf_fiducial_1to3_b0.273d_hdf5_plt_cnt_0175_Profile2D_0_Density_Temperature_CellMassMsun.png
+ :width: 250
+
+Simple Phase Plots
+~~~~~~~~~~~~~~~~~~
+
+This demonstrates how to make a phase plot. Phase plots can be thought of as
+two-dimensional histograms, where the value is either the weighted-average or
+the total accumualtion in a cell.
+
+.. literalinclude:: simple_phase.py
+
+.. image:: _static/simple_phase_galaxy0030_Profile2D_0_Density_Temperature_CellMassMsun.png
+ :width: 250
+
+Simple 1D Histograms
+~~~~~~~~~~~~~~~~~~~~
+
+This is a "profile," which is a 1D profile. This can be thought of as either
+the total accumulation (when weight is set to ``None``) or the average (when a
+weight is supplied.)
+
+.. literalinclude:: simple_profile.py
+
+.. image:: _static/simple_profile_galaxy0030_Profile1D_0_Density_Temperature.png
+ :width: 250
+
+Simple Projections
+~~~~~~~~~~~~~~~~~~
+
+This is the simplest way to make a projection through a dataset.
+
+.. literalinclude:: simple_projection.py
+
+.. image:: _static/simple_projection_fiducial_1to3_b0.273d_hdf5_plt_cnt_0175_Projection_x_Density_Density.png
+ :width: 250
+
+.. image:: _static/simple_projection_fiducial_1to3_b0.273d_hdf5_plt_cnt_0175_Projection_y_Density_Density.png
+ :width: 250
+
+.. image:: _static/simple_projection_fiducial_1to3_b0.273d_hdf5_plt_cnt_0175_Projection_z_Density_Density.png
+ :width: 250
+
+Simple Radial Profiles
+~~~~~~~~~~~~~~~~~~~~~~
+
+This shows how to make a profile of a quantity with respect to the radius, in
+this case the radius in Mpc.
+
+.. literalinclude:: simple_radial_profile.py
+
+.. image:: _static/simple_radial_profile_galaxy0030_Profile1D_0_RadiusMpc_Density.png
+ :width: 250
+
+Simple Volume Rendering
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Here we see how to make a very simple volume rendering, where each option is
+considered in turn.
+
+.. literalinclude:: simple_volume_rendering.py
+
+.. image:: _static/simple_volume_rendering_data0043_volume_rendered.png
+ :width: 250
+
+Off-Axis Slicing
+~~~~~~~~~~~~~~~~
+
+A cutting plane allows you to slice at some angle that isn't aligned with the
+axes.
+
+.. literalinclude:: aligned_cutting_plane.py
+
https://bitbucket.org/yt_analysis/yt-doc/changeset/4df4b25c2cb9/
changeset: 4df4b25c2cb9
user: MatthewTurk
date: 2012-07-07 13:41:18
summary: Oops, somehow I missed removing these.
affected #: 11 files
diff -r f3477f45d94a3fdf2878ca004329f96290c7e4c8 -r 4df4b25c2cb9a60958c9862dd3fd4c93459c6c22 source/reference/api/callback_list.rst
--- a/source/reference/api/callback_list.rst
+++ /dev/null
@@ -1,32 +0,0 @@
-.. _callback-api:
-
-Callback List
-=============
-
-.. py:module:: yt.visualization
-
-See also :ref:`callbacks`.
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.visualization.plot_modifications.ArrowCallback
- ~yt.visualization.plot_modifications.ClumpContourCallback
- ~yt.visualization.plot_modifications.ContourCallback
- ~yt.visualization.plot_modifications.CoordAxesCallback
- ~yt.visualization.plot_modifications.CuttingQuiverCallback
- ~yt.visualization.plot_modifications.GridBoundaryCallback
- ~yt.visualization.plot_modifications.HopCircleCallback
- ~yt.visualization.plot_modifications.HopParticleCallback
- ~yt.visualization.plot_modifications.LabelCallback
- ~yt.visualization.plot_modifications.LinePlotCallback
- ~yt.visualization.plot_modifications.MarkerAnnotateCallback
- ~yt.visualization.plot_modifications.ParticleCallback
- ~yt.visualization.plot_modifications.PointAnnotateCallback
- ~yt.visualization.plot_modifications.QuiverCallback
- ~yt.visualization.plot_modifications.SphereCallback
- ~yt.visualization.plot_modifications.TextLabelCallback
- ~yt.visualization.plot_modifications.TitleCallback
- ~yt.visualization.plot_modifications.UnitBoundaryCallback
- ~yt.visualization.plot_modifications.VelocityCallback
- ~yt.visualization.plot_modifications.VobozCircleCallback
diff -r f3477f45d94a3fdf2878ca004329f96290c7e4c8 -r 4df4b25c2cb9a60958c9862dd3fd4c93459c6c22 source/reference/api/data_sources.rst
--- a/source/reference/api/data_sources.rst
+++ /dev/null
@@ -1,117 +0,0 @@
-Data Sources
-============
-
-.. py:module:: yt.data_objects
-
-.. _physical-object-api:
-
-Physical Objects
-----------------
-
-These are the objects that act as physical selections of data, describing a
-region in space. These are not typically addressed directly; see
-:ref:`available-objects` for more information.
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.data_objects.data_containers.AMRData
- ~yt.data_objects.data_containers.AMR1DData
- ~yt.data_objects.data_containers.AMR2DData
- ~yt.data_objects.data_containers.AMR3DData
- ~yt.data_objects.data_containers.AMRCoveringGridBase
- ~yt.data_objects.data_containers.AMRCuttingPlaneBase
- ~yt.data_objects.data_containers.AMRCylinderBase
- ~yt.data_objects.data_containers.AMRGridCollectionBase
- ~yt.data_objects.data_containers.AMRRayBase
- ~yt.data_objects.data_containers.AMROrthoRayBase
- ~yt.data_objects.data_containers.AMRStreamlineBase
- ~yt.data_objects.data_containers.AMRProjBase
- ~yt.data_objects.data_containers.AMRRegionBase
- ~yt.data_objects.data_containers.AMRSliceBase
- ~yt.data_objects.data_containers.AMRSmoothedCoveringGridBase
- ~yt.data_objects.data_containers.AMRSphereBase
-
-Time Series Objects
--------------------
-
-These are objects that either contain and represent or operate on series of
-datasets.
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.data_objects.time_series.TimeSeriesData
- ~yt.data_objects.time_series.TimeSeriesDataObject
- ~yt.data_objects.time_series.TimeSeriesQuantitiesContainer
- ~yt.data_objects.time_series.AnalysisTaskProxy
-
-Frontends
----------
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.data_objects.grid_patch.AMRGridPatch
- ~yt.data_objects.hierarchy.AMRHierarchy
- ~yt.data_objects.static_output.StaticOutput
-
-Enzo
-++++
-
-.. py:module:: yt.frontends.enzo
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.frontends.enzo.data_structures.EnzoGrid
- ~yt.frontends.enzo.data_structures.EnzoHierarchy
- ~yt.frontends.enzo.data_structures.EnzoStaticOutput
-
-Orion
-+++++
-
-.. py:module:: yt.frontends.orion
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.frontends.orion.data_structures.OrionGrid
- ~yt.frontends.orion.data_structures.OrionHierarchy
- ~yt.frontends.orion.data_structures.OrionStaticOutput
-
-FLASH
-+++++
-
-.. py:module:: yt.frontends.flash
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.frontends.flash.data_structures.FLASHGrid
- ~yt.frontends.flash.data_structures.FLASHHierarchy
- ~yt.frontends.flash.data_structures.FLASHStaticOutput
-
-Chombo
-++++++
-
-.. py:module:: yt.frontends.chombo
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.frontends.chombo.data_structures.ChomboGrid
- ~yt.frontends.chombo.data_structures.ChomboHierarchy
- ~yt.frontends.chombo.data_structures.ChomboStaticOutput
-
-RAMSES
-++++++
-
-.. py:module:: yt.frontends.ramses
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.frontends.ramses.data_structures.RAMSESGrid
- ~yt.frontends.ramses.data_structures.RAMSESHierarchy
- ~yt.frontends.ramses.data_structures.RAMSESStaticOutput
diff -r f3477f45d94a3fdf2878ca004329f96290c7e4c8 -r 4df4b25c2cb9a60958c9862dd3fd4c93459c6c22 source/reference/api/derived_datatypes.rst
--- a/source/reference/api/derived_datatypes.rst
+++ /dev/null
@@ -1,49 +0,0 @@
-
-Derived Datatypes
-=================
-
-Profiles and Histograms
------------------------
-
-These types are used to sum data up and either return that sum or return an
-average. Typically they are more easily used through the
-`yt.visualization.plot_collection` interface.
-
-.. py:module:: yt.data_objects
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.data_objects.profiles.BinnedProfile1D
- ~yt.data_objects.profiles.BinnedProfile2D
- ~yt.data_objects.profiles.BinnedProfile3D
-
-Halo Finding and Particle Functions
------------------------------------
-
-Halo finding can be executed using these types.
-
-.. py:module:: yt.analysis_modules.halo_finding
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.analysis_modules.halo_finding.halo_objects.FOFHaloFinder
- ~yt.analysis_modules.halo_finding.halo_objects.HOPHaloFinder
- ~yt.analysis_modules.halo_finding.halo_objects.Halo
- ~yt.analysis_modules.halo_finding.halo_objects.HaloList
-
-Two Point Functions
--------------------
-
-These functions are designed to create correlations or other results of
-operations acting on two spatially-distinct points in a data source. See also
-:ref:`two_point_functions`.
-
-.. py:module:: yt.analysis_modules.two_point_functions
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.analysis_modules.api.TwoPointFunctions
- ~yt.analysis_modules.api.FcnSet
diff -r f3477f45d94a3fdf2878ca004329f96290c7e4c8 -r 4df4b25c2cb9a60958c9862dd3fd4c93459c6c22 source/reference/api/derived_quantities.rst
--- a/source/reference/api/derived_quantities.rst
+++ /dev/null
@@ -1,21 +0,0 @@
-Derived Quantities
-==================
-
-See :ref:`derived-quantities`.
-
-.. py:module:: yt.data_objects
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.data_objects.derived_quantities._AngularMomentumVector
- ~yt.data_objects.derived_quantities._BaryonSpinParameter
- ~yt.data_objects.derived_quantities._BulkVelocity
- ~yt.data_objects.derived_quantities._CenterOfMass
- ~yt.data_objects.derived_quantities._Extrema
- ~yt.data_objects.derived_quantities._IsBound
- ~yt.data_objects.derived_quantities._MaxLocation
- ~yt.data_objects.derived_quantities._ParticleSpinParameter
- ~yt.data_objects.derived_quantities._TotalMass
- ~yt.data_objects.derived_quantities._TotalQuantity
- ~yt.data_objects.derived_quantities._WeightedAverageQuantity
diff -r f3477f45d94a3fdf2878ca004329f96290c7e4c8 -r 4df4b25c2cb9a60958c9862dd3fd4c93459c6c22 source/reference/api/extension_types.rst
--- a/source/reference/api/extension_types.rst
+++ /dev/null
@@ -1,122 +0,0 @@
-Extension Types
-===============
-
-Coordinate Transformations
---------------------------
-
-.. py:module:: yt.analysis_modules.coordinate_transformation
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.analysis_modules.coordinate_transformation.transforms.arbitrary_regrid
- ~yt.analysis_modules.coordinate_transformation.transforms.spherical_regrid
-
-Cosmology and Star Particle Analysis
-------------------------------------
-
-For the generation of stellar SEDs. (See also :ref:`star_analysis`.)
-
-.. py:module:: yt.analysis_modules.star_analysis
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.analysis_modules.star_analysis.sfr_spectrum.StarFormationRate
- ~yt.analysis_modules.star_analysis.sfr_spectrum.SpectrumBuilder
-
-Light cone generation and simulation analysis. (See also
-:ref:`light-cone-generator`.)
-
-.. py:module:: yt.analysis_modules.light_cone
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.analysis_modules.light_cone.light_cone.LightCone
-
-Volume Rendering
-----------------
-
-See also :ref:`volume_rendering`.
-
-.. py:module:: yt.visualization.volume_rendering
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.visualization.volume_rendering.camera.Camera
- ~yt.visualization.volume_rendering.camera.off_axis_projection
- ~yt.visualization.volume_rendering.transfer_functions.ColorTransferFunction
- ~yt.visualization.volume_rendering.grid_partitioner.HomogenizedVolume
- ~yt.visualization.volume_rendering.transfer_functions.MultiVariateTransferFunction
- ~yt.utilities.amr_utils.PartitionedGrid
- ~yt.utilities.amr_kdtree.amr_kdtree.AMRKDTree
- ~yt.visualization.volume_rendering.camera.PerspectiveCamera
- ~yt.visualization.volume_rendering.transfer_functions.PlanckTransferFunction
- ~yt.visualization.volume_rendering.transfer_functions.ProjectionTransferFunction
- ~yt.visualization.volume_rendering.camera.StereoPairCamera
- ~yt.visualization.volume_rendering.transfer_functions.TransferFunction
-
-.. _image_writer:
-
-Streamlining
-----------------
-
-See also :ref:`streamlines`.
-
-.. py:module:: yt.visualization.streamlines
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.visualization.streamlines.Streamlines
-
-Image Writing
--------------
-
-These functions are all used for fast writing of images directly to disk,
-without calling matplotlib. This can be very useful for high-cadence outputs
-where colorbars are unnecessary or for volume rendering.
-
-.. py:module:: yt.visualization
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.visualization.image_writer.multi_image_composite
- ~yt.visualization.image_writer.write_bitmap
- ~yt.visualization.image_writer.write_image
- ~yt.visualization.image_writer.map_to_colors
- ~yt.visualization.image_writer.strip_colormap_data
- ~yt.visualization.image_writer.splat_points
- ~yt.visualization.image_writer.annotate_image
-
-We also provide a module that is very good for generating EPS figures,
-particularly with complicated layouts.
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.visualization.eps_writer.DualEPS
- ~yt.visualization.eps_writer.single_plot
- ~yt.visualization.eps_writer.multiplot
- ~yt.visualization.eps_writer.multiplot_yt
- ~yt.visualization.eps_writer.return_cmap
-
-.. _image-panner-api:
-
-Image Panning and Scanning
---------------------------
-
-See also :ref:`image-panner`.
-
-.. py:module:: yt.visualization.image_panner
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.visualization.image_panner.vm_panner.VariableMeshPanner
- ~yt.visualization.image_panner.vm_panner.WindowedVariableMeshPanner
- ~yt.visualization.image_panner.vm_panner.MultipleWindowVariableMeshPanner
- ~yt.visualization.image_panner.vm_panner.ImageSaver
diff -r f3477f45d94a3fdf2878ca004329f96290c7e4c8 -r 4df4b25c2cb9a60958c9862dd3fd4c93459c6c22 source/reference/api/field_types.rst
--- a/source/reference/api/field_types.rst
+++ /dev/null
@@ -1,16 +0,0 @@
-
-Field Types
-===========
-
-.. py:module:: yt.data_objects
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.data_objects.field_info_container.DerivedField
- ~yt.data_objects.field_info_container.FieldInfoContainer
- ~yt.data_objects.field_info_container.ValidateDataField
- ~yt.data_objects.field_info_container.ValidateGridType
- ~yt.data_objects.field_info_container.ValidateParameter
- ~yt.data_objects.field_info_container.ValidateProperty
- ~yt.data_objects.field_info_container.ValidateSpatial
diff -r f3477f45d94a3fdf2878ca004329f96290c7e4c8 -r 4df4b25c2cb9a60958c9862dd3fd4c93459c6c22 source/reference/api/function_list.rst
--- a/source/reference/api/function_list.rst
+++ /dev/null
@@ -1,33 +0,0 @@
-Function List
-=============
-
-.. py:module:: yt.funcs
-.. py:module:: yt.analysis_modules.level_sets
-.. py:module:: yt.utilities
-.. py:module:: yt.utilities.parallel_tools
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.convenience.all_pfs
- ~yt.convenience.load
- ~yt.convenience.max_spheres
- ~yt.funcs.deprecate
- ~yt.funcs.ensure_list
- ~yt.funcs.get_pbar
- ~yt.funcs.humanize_time
- ~yt.funcs.insert_ipython
- ~yt.funcs.iterable
- ~yt.funcs.just_one
- ~yt.funcs.only_on_root
- ~yt.funcs.paste_traceback
- ~yt.funcs.pdb_run
- ~yt.funcs.print_tb
- ~yt.funcs.rootonly
- ~yt.funcs.time_execution
- ~yt.analysis_modules.level_sets.contour_finder.identify_contours
- ~yt.utilities.parallel_tools.parallel_analysis_interface.parallel_blocking_call
- ~yt.utilities.parallel_tools.parallel_analysis_interface.parallel_passthrough
- ~yt.utilities.parallel_tools.parallel_analysis_interface.parallel_root_only
- ~yt.utilities.parallel_tools.parallel_analysis_interface.parallel_simple_proxy
- ~yt.utilities.parallel_tools.parallel_analysis_interface.parallel_splitter
diff -r f3477f45d94a3fdf2878ca004329f96290c7e4c8 -r 4df4b25c2cb9a60958c9862dd3fd4c93459c6c22 source/reference/api/index.rst
--- a/source/reference/api/index.rst
+++ /dev/null
@@ -1,17 +0,0 @@
-.. _reference-api:
-
-API Documentation
-=======================
-
-.. toctree::
- :maxdepth: 1
-
- plot_types
- data_sources
- derived_datatypes
- field_types
- extension_types
- derived_quantities
- callback_list
- function_list
- misc_types
diff -r f3477f45d94a3fdf2878ca004329f96290c7e4c8 -r 4df4b25c2cb9a60958c9862dd3fd4c93459c6c22 source/reference/api/misc_types.rst
--- a/source/reference/api/misc_types.rst
+++ /dev/null
@@ -1,23 +0,0 @@
-
-Miscellaneous Types
-===================
-
-.. py:module:: yt.config
-.. py:module:: yt.analysis_modules.hierarchy_subset
-.. py:module:: yt.analysis_modules.spectral_integrator
-.. py:module:: yt.utilities
-.. py:module:: yt.analysis_modules.level_sets
-.. py:module:: yt.utilities.parallel_tools
-
-.. autosummary::
- :toctree: generated/
-
- ~yt.config.YTConfigParser
- ~yt.analysis_modules.hierarchy_subset.hierarchy_subset.ConstructedRootGrid
- ~yt.analysis_modules.hierarchy_subset.hierarchy_subset.ExtractedHierarchy
- ~yt.analysis_modules.spectral_integrator.spectral_frequency_integrator.SpectralFrequencyIntegrator
- ~yt.utilities.parameter_file_storage.ParameterFileStore
- ~yt.data_objects.data_containers.FakeGridForParticles
- ~yt.utilities.parallel_tools.parallel_analysis_interface.ObjectIterator
- ~yt.utilities.parallel_tools.parallel_analysis_interface.ParallelAnalysisInterface
- ~yt.utilities.parallel_tools.parallel_analysis_interface.ParallelObjectIterator
diff -r f3477f45d94a3fdf2878ca004329f96290c7e4c8 -r 4df4b25c2cb9a60958c9862dd3fd4c93459c6c22 source/reference/api/plot_types.rst
--- a/source/reference/api/plot_types.rst
+++ /dev/null
@@ -1,18 +0,0 @@
-Plots and the Plotting Interface
-================================
-
-.. py:module:: yt.visualization
-
-.. autosummary::
- :toctree: generated/
-
- yt.visualization.plot_collection.PlotCollection
- yt.visualization.plot_collection.PlotCollectionInteractive
- yt.visualization.plot_types.SlicePlot
- yt.visualization.plot_types.ProjectionPlot
- yt.visualization.plot_types.PhasePlot
- yt.visualization.plot_types.Profile1DPlot
- yt.visualization.fixed_resolution.FixedResolutionBuffer
- yt.visualization.fixed_resolution.ObliqueFixedResolutionBuffer
- yt.visualization.profile_plotter.PhasePlotter
- yt.visualization.plot_collection.get_multi_plot
diff -r f3477f45d94a3fdf2878ca004329f96290c7e4c8 -r 4df4b25c2cb9a60958c9862dd3fd4c93459c6c22 source/reference/index.rst
--- a/source/reference/index.rst
+++ /dev/null
@@ -1,10 +0,0 @@
-Reference Documentation
-=======================
-
-.. toctree::
- :maxdepth: 1
-
- field_list
- configuration
- changelog
- api/index
https://bitbucket.org/yt_analysis/yt-doc/changeset/bc0bc20ac455/
changeset: bc0bc20ac455
user: MatthewTurk
date: 2012-07-07 13:41:25
summary: Merging
affected #: 1 file
diff -r 4df4b25c2cb9a60958c9862dd3fd4c93459c6c22 -r bc0bc20ac45599a1b3df7eb80ddb255d42531905 source/advanced/reason_architecture.rst
--- /dev/null
+++ b/source/advanced/reason_architecture.rst
@@ -0,0 +1,190 @@
+Reason Architecture
+===================
+
+Reason (see :ref:`reason`) has been ported as of 2.4 to work with the `ExtJS4
+<http://www.sencha.com/>`_ framework. The architecture has been completely
+reworked in the style of 'model-view-controller,' and the source tree has been
+laid out to reflect this.
+
+The javascript objects are laid out in a clear namespace, which corresponds to
+their layout on disk. For instance, ``Reason.controller.DataObjects``
+corresponds to ``app/Reason/controller/DataObjects.js``.
+
+ * ``app.js``: This is where the main application object is instantiated and
+ the Viewport created.
+ * ``app/Reason/view/*``: Objects corresponding to the display of Reason on the page.
+ These only contain markup; no logic code.
+ * ``app/Reason/view/widgets/*``: Objects corresponding to the display of widgets
+ in the Reason windows. These only contain markup; no logic code.
+ * ``app/Reason/controller/*``: Objects corresponding to controlling actions, data,
+ and interactions between components. These can contain logic code.
+ * ``app/Reason/controller/widgets/*``: Widget objects that can talk to yt, and the
+ mechanisms for controlling them. See :ref:`adding_widgets` for more
+ information.
+ * ``app/Reason/templates/*``: Template Management helper classes.
+ * ``app/Reason/store/*``: The definitions of data stores, where objects can be
+ inserted, filtered, queried and displayed.
+ * ``app/Reason/store/widgets/*``: Stores for widget data.
+ * ``app/Reason/model/*``: Any models that correspond to data store members
+ live here. Note that we usually use implicit models, except for data objects
+ that live in the tree.
+
+Each class exists in its own file, as per the ExtJS standard. Each class is
+defined inside an ``Ext.define`` block, extending the appropriate type of
+component. Wherever possible, lazy-evaluations are done and variables are not
+created by Reason's js code.
+
+Below we describe this in somewhat more detail.
+
+MVC Components
+--------------
+
+The ExtJS philosophy of separating models, views and controllers works quite
+well for what Reason is designed to do. While more detailed discussions of
+this can be found in the ExtJS4 docuemntation, for our purposes this separates
+into:
+
+ * Model: In our situation, the model is typically the same as a store. This
+ is the fundamental data object being passed around. For the purposes of using
+ and developing Reason, the main data objects are the cells, the parameter
+ files and attendent yt data objects, the payloads from the server (including
+ things like new images to display in the plot windows) and the widgets.
+ Each of these has a store, and each can be operated on and viewed in
+ different ways.
+ * Controller: The object that possesses a view, potentially a store, and
+ creates application logic to tie the display to the data. For instance, a
+ widget possesses a controller. This controller sets up handlers for events
+ that occur on a widget, and it also accepts payloads and updates the widget.
+ In this way, layout code is completely independent of application logic, and
+ both can be updated more easily and independently.
+ * View: The display mechanism for objects. In our terminology, this is simply
+ a javascript config object that tells ExtJS what a layout should look like
+ and what its components should be called.
+
+To keep the code maintainable, *all* logic should exist only within
+controllers. Controllers in ExtJS are powerful enough to get references to
+views automatically, create and update window state, and issue commands.
+
+For creating widgets, there is a special set of methods provided to do things
+like tie events together, execute commands in yt, and get references to
+objects. These are described below in :ref:`adding_widgets`.
+
+Adding a new Widget
+-------------------
+
+The procedure for adding a new widget is straightforward, but details of
+implementation may pose problems. In particular, JavaScript has scoping rules
+that sometimes trip up developers coming from Python, as the variable "this" is
+implicit rather than explicit (and can be modified by the calling function.)
+
+A skeleton widget is available in "SimpleWidget.js." This shows all of the
+places that your code may override existing code, and it provides a sample for
+how to create custom control code.
+
+Here are the steps:
+
+ #. Create a new widget file in ``app/controller/widgets/YourWidget.js``. For
+ what this widget needs to implement, see just below.
+ #. Create a new view for this widget in ``app/view/widgets/YourWidget.js``.
+ If necessary, also create a ``aap/view/widgets/YourWidgetCreator.js`` to
+ serve as a creation window, querying the user.
+ #. Add the widget to the ``requires`` section in the
+ ``app/controller/WidgetDirector.js`` file, similar to how the other widgets
+ are implemented.
+
+For the widget to function, a small amount of routines and variables either
+must be or can be set.
+
+ * ``templates`` (optional): This should be a mapping from the name of the
+ template to a string in the form of an Ext.XTemplate. This template will
+ have access to the variables ``widget``, which will be the view object, as
+ well as the handler's arguments in the form ``a0``, ``a1``, ``a2``, and so
+ on. To access these variables, place them inside single ``{`` and ``}``
+ brackets. To call javascript code (such as to get references to Ext
+ components, as in the PlotWindow wiget) put square brackets inside the curly
+ brackets. The PlotWindow widget is the most advanced example of the usage
+ of templates, and the Scene widget has a simpler yet complete example.
+ * ``widgetTriggers`` (optional): A array of arrays, composed of the itemId of
+ the object on which to place a handler, the handler to implement, and the
+ name of the function to call on that handler. For instance, you could bind a
+ button with the click event and have it call a function on the controller.
+ * ``executionTriggers`` (optional): This is similar to the ``widgetTriggers``
+ object, except that instead of the name of the function on the controller
+ to call, the name of the template to be evaluated and sent to the server
+ for execution in Python space is provided. This allows for very simple
+ binding of buttons, dropdowns and so on to the execution of Python code on
+ the server.
+ * ``viewRefs`` (optional): Because multiple controllers can be instantiated,
+ each with their own views, the standard mechanism for tracking views in
+ ExtJS doesn't quite work. This provides a workaround. It implements
+ identical logic to the ``views`` mechanism in ExtJS (see the ExtJS4 docs for
+ more info) but the view queried will only be the view affiliated with the
+ variable desired.
+ * ``createView``: This function must define a view, which should be returned
+ from the function. The view should also be assigned to the controller
+ object (i.e., ``this.plotWindowView = ...``). It can also create helper
+ widgets, as the PlotWindow does.
+ * ``applyPayload``: This must accept a ``payload`` object and apply its
+ contents to the widget.
+ * ``statics: widgetName``: This variable, defined under the ``statics``
+ namespace, is the (tokenizable and unique) shortname of the widget.
+ * ``statics: supportsDataObjects``: should this widget be applied to data
+ objects created from parameter files? (true or false)
+ * ``statics: supportsParameterFiles``: should this widget be applied to
+ parameter files? (true or false)
+ * ``statics: displayName``: What should this widget show up as in the context
+ menu?
+ * ``statics: preCreation``: This function, called with either a data object or
+ a parameter file object, will be called when the item is selected from the
+ context menu. It can spawn new views (potentially of creation widgets) and
+ if successful a widget payload should be expected from the server.
+
+For an example of a fully-fledged widget that accepts data from the server,
+applies callbacks and expects new data, see the ``PlotWindow.js`` controller
+file and its affiliated views. For a much simpler, static data-display
+widgets, see ``GridDataViewer.js`` and its affiliated class files. The
+``Scene.js`` controller file demonstrates most functionality.
+
+To create the widget on the Python side, you must create a member function in
+the ``widget_store.py`` file. This member function can accept whatever
+arguments you like, and must create a persistent object that can be controlled
+by Reason. For example, the ``create_slice`` function accepts a parameter file
+and some slice parameters, and then creates a widget payload describing the
+plot window that uses that slice. This plot window knows how to deliver
+payloads back to the clientside web browser, which are threaded through to the
+isntance of the PlotWindow controller's ``applyPayload`` mechanism. In this
+way, the Javascript code can call methods in Python, which can then supply
+results that are rich in data.
+
+How to Call yt Functions
+------------------------
+
+We currently use Ext.Direct to communicate with yt on the server, from the web
+browser. This allows us to have an RPC interface. All cell contents are
+supplied via payloads, with a heartbeat function that runs at regular (fast)
+intervals. To call a function on the server, use the
+``reason.server.execute`` function, supplying the ``code`` and (optionally)
+``hide`` values arguments. You can also supply a callback function; in this
+case, the input cell will not be disabled during the call to the server.
+
+.. code-block:: javascript
+
+ reason.server.execute(code, false);
+
+To call a function implemneted on the ExtDirectREPL, replace ``method`` and
+supply the first argument as a string of the method name. Widget creation
+should be done in this manner on the server-side.
+
+Debugging
+---------
+
+Debugging javascript can be much different from debugging Python code. If you
+are developing a new widget in reason, opening the console should be your first
+attempt whenever something goes wrong. In Chrome, this is done with
+Ctrl-Alt-j. In the main Reason menu there is also a debugging option, which
+will open up grid views of data objects that have been passed to the server.
+
+To access widgets, use the ``Reason.debug`` object's query functions.
+Additionally, the global variable ``examine`` exists in the main namespace, and
+this variable can be assigned values and inspected in the console. To log an
+entry to the javascript console, use ``console.log('your message here');``.
https://bitbucket.org/yt_analysis/yt-doc/changeset/aa6ea150c050/
changeset: aa6ea150c050
user: MatthewTurk
date: 2012-07-07 14:15:46
summary: Adding a table-creator helper script. Also, including the output of that
script. Probably needs more tweaking, but the idea is to have it all
vertically laid out now, instead of two-by-two.
affected #: 2 files
diff -r bc0bc20ac45599a1b3df7eb80ddb255d42531905 -r aa6ea150c0505bc3d9da1ca782ee940b32e42ad2 helper_scripts/table.py
--- /dev/null
+++ b/helper_scripts/table.py
@@ -0,0 +1,75 @@
+contents = [
+ ("Getting Started", [
+ ("welcome/index.html", "Welcome to yt!",
+ "What's yt all about?"),
+ ("orientation/index.html", "yt Orientation",
+ "Quickly get up and running with yt: zero to sixty."),
+ ("help/index.html", "How to Ask for Help",
+ "Some guidelines on how and where to ask for help with yt"),
+ ]),
+ ("Everyday yt", [
+ ("analyzing/index.html", "Analyzing Data",
+ "An overview of different ways to handle and process data: loading " +
+ "data, using and manipulating objects and fields, examining and " +
+ "manipulating particles, derived fields, generating processed data, " +
+ "time series analysis."),
+ ("visualizing/index.html", "Visualizing Data",
+ "An overview of different ways to visualize data: making projections, " +
+ "slices, phase plots, streamlines, and volume rendering; modifying " +
+ "plots; the fixed resolution buffer."),
+ ("interacting/index.html", "Interacting with yt",
+ "Different ways -- scripting, GUIs, prompts, explorers -- to explore " +
+ "your data."),
+ ("analysis_modules/index.html", "Analysis Modules",
+ "Discussions of some provided procedures for astrophysical analysis " +
+ "like halo finding and synthetic spectra. Halo finding, analyzing " +
+ "cosmology simulations, halo mass functions, halo profiling, light " +
+ "cone generator, making absorption spectrums, star particle " +
+ "analysis, two-point functions, halo merger trees, clump finding, " +
+ "radial column density, exporting to sunrise.")
+ ]),
+ ("Advanced Usage", [
+ ("advanced/index.html", "Advanced yt usage",
+ "Advanced topics: parallelism, debugging, ways to drive yt, " +
+ "developing"),
+ ("getting_involved/index.html", "Getting Involved",
+ "How to participate in the community, contribute code and share " +
+ "scripts"),
+ ]),
+ ("Reference Materials", [
+ ("cookbook/index.html", "The Cookbook",
+ "A bunch of illustrated examples of how to do things"),
+ ("reference/index.html", "Reference Materials",
+ "A list of all bundled fields, API documentation, the Change Log..."),
+ ("faq/index.html", "FAQ",
+ "Frequently Asked Questions: answered for you!")
+ ]),
+]
+
+heading_template = r"""
+<h2>%s</h2>
+<table class="contentstable" align="center">
+%s
+</table>
+"""
+
+subheading_template = r"""
+ <tr valign="top">
+ <td width="25%%">
+ <p>
+ <a href="%s">%s</a>
+ </p>
+ </td>
+ <td width="75%%">
+ <p class="linkdescr">%s</p>
+ </td>
+ </tr>
+"""
+
+t = ""
+for heading, items in contents:
+ s = ""
+ for subheading in items:
+ s += subheading_template % subheading
+ t += heading_template % (heading, s)
+print t
diff -r bc0bc20ac45599a1b3df7eb80ddb255d42531905 -r aa6ea150c0505bc3d9da1ca782ee940b32e42ad2 source/index.rst
--- a/source/index.rst
+++ b/source/index.rst
@@ -51,134 +51,153 @@
<h2>Getting Started</h2><table class="contentstable" align="center">
- <tr valign="top">
- <td width="50%">
- <p class="biglink">
- <a class="biglink" href="welcome/index.html">
- Welcome to yt!</a><br>
- <span class="linkdescr">
- What's yt all about?
- </span></p>
- </td>
- <td width="50%">
- <p class="biglink">
- <a class="biglink" href="orientation/index.html">
- yt Orientation</a><br>
- <span class="linkdescr">
- Quickly get up and running with yt: zero to sixty.
- </span></p>
- </td>
- </tr>
- <tr valign="top">
- <td width="50%">
- <p class="biglink">
- <a class="biglink" href="help/index.html">
- How to Ask for Help</a><br>
- <span class="linkdescr">
- Some guidelines on how and where to ask for help with yt
- </span></p>
- </td>
- </tr>
- </table>
-
+
+ <tr valign="top">
+ <td width="25%">
+ <p>
+ <a href="welcome/index.html">Welcome to yt!</a>
+ </p>
+ </td>
+ <td width="75%">
+ <p class="linkdescr">What's yt all about?</p>
+ </td>
+ </tr>
+
+ <tr valign="top">
+ <td width="25%">
+ <p>
+ <a href="orientation/index.html">yt Orientation</a>
+ </p>
+ </td>
+ <td width="75%">
+ <p class="linkdescr">Quickly get up and running with yt: zero to sixty.</p>
+ </td>
+ </tr>
+
+ <tr valign="top">
+ <td width="25%">
+ <p>
+ <a href="help/index.html">How to Ask for Help</a>
+ </p>
+ </td>
+ <td width="75%">
+ <p class="linkdescr">Some guidelines on how and where to ask for help with yt</p>
+ </td>
+ </tr>
+
+ </table>
+
<h2>Everyday yt</h2>
-
<table class="contentstable" align="center">
- <tr valign="top">
- <td width="50%">
- <p class="biglink">
- <a class="biglink" href="analyzing/index.html">
- Analyzing Data</a><br>
- <span class="linkdescr">
- An overview of different ways to handle and process data: loading
- data, using and manipulating objects and fields, examining and
- manipulating particles, derived fields, generating processed data,
- time series analysis.
- </span></p>
- </td>
- <td width="50%">
- <p class="biglink">
- <a class="biglink" href="visualizing/index.html">
- Visualizing Data</a><br>
- <span class="linkdescr">
- An overview of different ways to visualize data: making projections,
- slices, phase plots, streamlines, and volume rendering; modifying
- plots; the fixed resolution buffer.
- </span></p>
- </td></tr>
- <tr valign="top">
- <td width="50%">
- <p class="biglink">
- <a class="biglink" href="interacting/index.html">
- Interacting with yt</a><br>
- <span class="linkdescr">
- Different ways -- scripting, GUIs, prompts, explorers -- to explore
- your data.
- </span></p>
- </td>
- <td width="50%">
- <p class="biglink">
- <a class="biglink" href="analysis_modules/index.html">
- Analysis Modules</a><br>
- <span class="linkdescr">
- Discussions of some provided procedures for astrophysical analysis
- like halo finding and synthetic spectra. Halo finding, analyzing
- cosmology simulations, halo mass functions, halo profiling, light
- cone generator, making absorption spectrums, star particle
- analysis, two-point functions, halo merger trees, clump finding,
- radial column density, exporting to sunrise.
- </span></p>
- </td></tr></table>
-
+
+ <tr valign="top">
+ <td width="25%">
+ <p>
+ <a href="analyzing/index.html">Analyzing Data</a>
+ </p>
+ </td>
+ <td width="75%">
+ <p class="linkdescr">An overview of different ways to handle and process data: loading data, using and manipulating objects and fields, examining and manipulating particles, derived fields, generating processed data, time series analysis.</p>
+ </td>
+ </tr>
+
+ <tr valign="top">
+ <td width="25%">
+ <p>
+ <a href="visualizing/index.html">Visualizing Data</a>
+ </p>
+ </td>
+ <td width="75%">
+ <p class="linkdescr">An overview of different ways to visualize data: making projections, slices, phase plots, streamlines, and volume rendering; modifying plots; the fixed resolution buffer.</p>
+ </td>
+ </tr>
+
+ <tr valign="top">
+ <td width="25%">
+ <p>
+ <a href="interacting/index.html">Interacting with yt</a>
+ </p>
+ </td>
+ <td width="75%">
+ <p class="linkdescr">Different ways -- scripting, GUIs, prompts, explorers -- to explore your data.</p>
+ </td>
+ </tr>
+
+ <tr valign="top">
+ <td width="25%">
+ <p>
+ <a href="analysis_modules/index.html">Analysis Modules</a>
+ </p>
+ </td>
+ <td width="75%">
+ <p class="linkdescr">Discussions of some provided procedures for astrophysical analysis like halo finding and synthetic spectra. Halo finding, analyzing cosmology simulations, halo mass functions, halo profiling, light cone generator, making absorption spectrums, star particle analysis, two-point functions, halo merger trees, clump finding, radial column density, exporting to sunrise.</p>
+ </td>
+ </tr>
+
+ </table>
+
<h2>Advanced Usage</h2><table class="contentstable" align="center">
- <tr valign="top">
- <td width="50%">
- <p class="biglink">
- <a class="biglink" href="advanced/index.html">
- Advanced yt usage</a><br>
- <span class="linkdescr">
- Advanced topics: parallelism, debugging, ways to drive yt,
- developing
- </span></p>
- </td>
- <td width="50%">
- <p class="biglink">
- <a class="biglink" href="getting_involved/index.html">
- Getting Involved</a><br>
- <span class="linkdescr">
- How to participate in the community, contribute code and share
- scripts
- </span></p>
- </td>
- </tr>
+
+ <tr valign="top">
+ <td width="25%">
+ <p>
+ <a href="advanced/index.html">Advanced yt usage</a>
+ </p>
+ </td>
+ <td width="75%">
+ <p class="linkdescr">Advanced topics: parallelism, debugging, ways to drive yt, developing</p>
+ </td>
+ </tr>
+
+ <tr valign="top">
+ <td width="25%">
+ <p>
+ <a href="getting_involved/index.html">Getting Involved</a>
+ </p>
+ </td>
+ <td width="75%">
+ <p class="linkdescr">How to participate in the community, contribute code and share scripts</p>
+ </td>
+ </tr>
+
</table><h2>Reference Materials</h2><table class="contentstable" align="center">
- <tr valign="top">
- <td width="50%">
- <p class="biglink">
- <a class="biglink" href="cookbook/index.html">
- The Cookbook</a><br>
- <span class="linkdescr">
- A bunch of illustrated examples of how to do things
- </span></p>
- </td>
- <td width="50%">
- <p class="biglink">
- <a class="biglink" href="reference/index.html">
- Reference Materials</a><br>
- <span class="linkdescr">
- A list of all bundled fields, API documentation, the Change Log...
- </span></p>
- <tr valign="top">
- <td width="50%">
- <p class="biglink">
- <a class="biglink" href="faq/index.html">
- FAQ</a><br>
- <span class="linkdescr">
- Frequently Asked Questions: answered for you!
- </span></p>
- </td></tr></table>
-
+
+ <tr valign="top">
+ <td width="25%">
+ <p>
+ <a href="cookbook/index.html">The Cookbook</a>
+ </p>
+ </td>
+ <td width="75%">
+ <p class="linkdescr">A bunch of illustrated examples of how to do things</p>
+ </td>
+ </tr>
+
+ <tr valign="top">
+ <td width="25%">
+ <p>
+ <a href="reference/index.html">Reference Materials</a>
+ </p>
+ </td>
+ <td width="75%">
+ <p class="linkdescr">A list of all bundled fields, API documentation, the Change Log...</p>
+ </td>
+ </tr>
+
+ <tr valign="top">
+ <td width="25%">
+ <p>
+ <a href="faq/index.html">FAQ</a>
+ </p>
+ </td>
+ <td width="75%">
+ <p class="linkdescr">Frequently Asked Questions: answered for you!</p>
+ </td>
+ </tr>
+
+ </table>
+
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.
More information about the yt-svn
mailing list