[yt-svn] commit/yt-doc: ngoldbaum: Fixing formatting errors and bad links.
commits-noreply at bitbucket.org
commits-noreply at bitbucket.org
Sat Nov 2 13:43:18 PDT 2013
1 new commit in yt-doc:
https://bitbucket.org/yt_analysis/yt-doc/commits/0a3b2ad3ff80/
Changeset: 0a3b2ad3ff80
User: ngoldbaum
Date: 2013-11-02 21:43:04
Summary: Fixing formatting errors and bad links.
Affected #: 6 files
diff -r 5ea7b96fc0e147a97eeacb8ab763381eafb4caaf -r 0a3b2ad3ff8021b2255135ef5281bd56a8d9a960 source/analyzing/analysis_modules/sunyaev_zeldovich.rst
--- a/source/analyzing/analysis_modules/sunyaev_zeldovich.rst
+++ b/source/analyzing/analysis_modules/sunyaev_zeldovich.rst
@@ -1,4 +1,4 @@
Mock Observations of the Sunyaev-Zeldovich Effect
------------------------------------------
+-------------------------------------------------
.. notebook:: SZ_projections.ipynb
diff -r 5ea7b96fc0e147a97eeacb8ab763381eafb4caaf -r 0a3b2ad3ff8021b2255135ef5281bd56a8d9a960 source/examining/generic_array_data.rst
--- a/source/examining/generic_array_data.rst
+++ b/source/examining/generic_array_data.rst
@@ -1,5 +1,5 @@
Loading Generic Array Data
-=================
+==========================
.. notebook:: Loading_Generic_Array_Data.ipynb
diff -r 5ea7b96fc0e147a97eeacb8ab763381eafb4caaf -r 0a3b2ad3ff8021b2255135ef5281bd56a8d9a960 source/examining/supported_frontends_data.rst
--- a/source/examining/supported_frontends_data.rst
+++ b/source/examining/supported_frontends_data.rst
@@ -1,7 +1,7 @@
.. _loading-data-from-supported-codes:
Loading Data from Supported Codes
-============
+=================================
This section contains information on how to load data into ``yt`` from
supported codes, as well as some important caveats about different
@@ -235,10 +235,7 @@
you shouldn't have to specify any keyword arguments to load in a dataset.
Athena Data
-----------
-=======
-.. loading-amr-data:
->>>>>>> other
+-----------
Athena 4.x VTK data is *mostly* supported and cared for by John
ZuHone. Both uniform grid and SMR datasets are supported.
@@ -298,4 +295,3 @@
refinement level to overlap with more than one grid on the parent
level. This may result in unpredictable behavior for some analysis
or visualization tasks.
-
diff -r 5ea7b96fc0e147a97eeacb8ab763381eafb4caaf -r 0a3b2ad3ff8021b2255135ef5281bd56a8d9a960 source/index.rst
--- a/source/index.rst
+++ b/source/index.rst
@@ -117,14 +117,23 @@
<tr valign="top"><td width="25%"><p>
- <a href="help/faq.html">FAQ</a>
+ <a href="faq/index.html">FAQ</a></p></td><td width="75%"><p class="linkdescr">Frequently Asked Questions</p></td></tr>
-
+ <tr valign="top">
+ <td width="25%">
+ <p>
+ <a href="sharing_data/index.html">Sharing Data and Code</a>
+ </p>
+ </td>
+ <td width="75%">
+ <p class="linkdescr">Sharing Data on the yt Hub</p>
+ </td>
+ </tr></table>
.. toctree::
@@ -140,4 +149,4 @@
reference/index
Getting Help <help/index>
FAQ <faq/index>
- sharing_data_hub
+ Sharing Data on the yt Hub <sharing_data/index>
diff -r 5ea7b96fc0e147a97eeacb8ab763381eafb4caaf -r 0a3b2ad3ff8021b2255135ef5281bd56a8d9a960 source/sharing_data/index.rst
--- /dev/null
+++ b/source/sharing_data/index.rst
@@ -0,0 +1,108 @@
+What is the yt Hub?
+===================
+
+The yt data hub is a mechanism by which images, data objects and projects can
+be shared with other people. For instance, one can upload projections and
+browse them with an interface similar to Google Maps.
+
+.. note:: All items posted on the hub are public!
+
+Over time, more widgets will be added, and more datatypes will be able to be
+uploaded. If you are interested in adding more ways of sharing data, please
+email the developers' list. We would like to add support for 3D widgets such
+as isocontours as well as interactive binning and rebinning of data from yt
+data objects, to be displayed as phase plots and profiles.
+
+Registering a User
+------------------
+
+Because of problems with spammers, registering a user can only be done from the
+yt command line. Once you have registered a user, you can log on to the
+website and obtain an API key.
+
+To register a user:
+
+.. code-block:: bash
+
+ $ yt hub_register
+
+This will walk you through the process of registering. You will need to supply
+a name, a username, a password and an email address. Once you have gotten that
+out of the way, you can go to http://hub.yt-project.org/login and log in with
+your new password. You can then receive your API key by clicking on your
+username in the upper left.
+
+After you have gotten your API key, place it in in your ``~/.yt/config`` file:
+
+.. code-block:: none
+
+ [yt]
+ hub_api_key = 3fd8de56c2884c13a2de4dd51a80974b
+
+Replace ``3fd8de56c2884c13a2de4dd51a80974b`` with your API key. At this point,
+you're ready to go!
+
+What Can Be Uploaded
+--------------------
+
+Currently, the yt hub can accept these types of data:
+
+ * Projects and script repositories: these will be displayed with an optional
+ image, a description, and a link to the source repository.
+ * Projections and Slices: these will be displayed in a maps-like interface,
+ for interactive panning and zooming
+ * Plot collections: these will be displayed as a list of images
+
+How to Upload Data
+------------------
+
+Uploading data takes place inside scripts. For the most part, it is relatively
+simple to do: you construct the object you would like to share, and then you
+upload it.
+
+Uploading Projects
+~~~~~~~~~~~~~~~~~~
+
+For information on how to share a project or a set of scripts, see
+:ref:`share-your-scripts`.
+
+Uploading Projections and Slices
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Projections and slices both have a ``hub_upload`` method. Here is an example
+of uploading a projection:
+
+.. code-block:: python
+
+ from yt.mods import *
+ pf = load("IsolatedGalaxy/galaxy0030/galaxy0030")
+ proj = pf.h.proj(0, "Density", weight="Density")
+ proj.hub_upload()
+
+Here is an example of uploading a slice:
+
+.. code-block:: python
+
+ from yt.mods import *
+ pf = load("JHK-DD0030/galaxy0030")
+ sl = pf.h.slice(0, 0.5, fields=["Density"])
+ sl.hub_upload()
+
+Uploading Plot Collections
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Plot collections can be uploaded and viewed as a selection of images. To
+upload a plot collection, call ``hub_upload`` on the plot collection.
+
+.. code-block:: python
+
+ from yt.mods import *
+ pf = load("DD0252/DD0252")
+ pc = PlotCollection(pf, 'c')
+ pc.add_projection("Density", 0)
+ pc.add_slice("Temperature", 1)
+ pc.add_profile_sphere(0.2, 'unitary', ["Density", "Temperature"])
+ dd = pf.h.all_data()
+ pc.add_phase_object(dd, ["Density", "Temperature", "CellMassMsun"],
+ weight=None)
+ pc.hub_upload()
diff -r 5ea7b96fc0e147a97eeacb8ab763381eafb4caaf -r 0a3b2ad3ff8021b2255135ef5281bd56a8d9a960 source/sharing_data_hub.rst
--- a/source/sharing_data_hub.rst
+++ /dev/null
@@ -1,108 +0,0 @@
-What is the yt Hub?
-===================
-
-The yt data hub is a mechanism by which images, data objects and projects can
-be shared with other people. For instance, one can upload projections and
-browse them with an interface similar to Google Maps.
-
-.. note:: All items posted on the hub are public!
-
-Over time, more widgets will be added, and more datatypes will be able to be
-uploaded. If you are interested in adding more ways of sharing data, please
-email the developers' list. We would like to add support for 3D widgets such
-as isocontours as well as interactive binning and rebinning of data from yt
-data objects, to be displayed as phase plots and profiles.
-
-Registering a User
-------------------
-
-Because of problems with spammers, registering a user can only be done from the
-yt command line. Once you have registered a user, you can log on to the
-website and obtain an API key.
-
-To register a user:
-
-.. code-block:: bash
-
- $ yt hub_register
-
-This will walk you through the process of registering. You will need to supply
-a name, a username, a password and an email address. Once you have gotten that
-out of the way, you can go to http://hub.yt-project.org/login and log in with
-your new password. You can then receive your API key by clicking on your
-username in the upper left.
-
-After you have gotten your API key, place it in in your ``~/.yt/config`` file:
-
-.. code-block:: none
-
- [yt]
- hub_api_key = 3fd8de56c2884c13a2de4dd51a80974b
-
-Replace ``3fd8de56c2884c13a2de4dd51a80974b`` with your API key. At this point,
-you're ready to go!
-
-What Can Be Uploaded
---------------------
-
-Currently, the yt hub can accept these types of data:
-
- * Projects and script repositories: these will be displayed with an optional
- image, a description, and a link to the source repository.
- * Projections and Slices: these will be displayed in a maps-like interface,
- for interactive panning and zooming
- * Plot collections: these will be displayed as a list of images
-
-How to Upload Data
-------------------
-
-Uploading data takes place inside scripts. For the most part, it is relatively
-simple to do: you construct the object you would like to share, and then you
-upload it.
-
-Uploading Projects
-~~~~~~~~~~~~~~~~~~
-
-For information on how to share a project or a set of scripts, see
-:ref:`share-your-scripts`.
-
-Uploading Projections and Slices
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Projections and slices both have a ``hub_upload`` method. Here is an example
-of uploading a projection:
-
-.. code-block:: python
-
- from yt.mods import *
- pf = load("IsolatedGalaxy/galaxy0030/galaxy0030")
- proj = pf.h.proj(0, "Density", weight="Density")
- proj.hub_upload()
-
-Here is an example of uploading a slice:
-
-.. code-block:: python
-
- from yt.mods import *
- pf = load("JHK-DD0030/galaxy0030")
- sl = pf.h.slice(0, 0.5, fields=["Density"])
- sl.hub_upload()
-
-Uploading Plot Collections
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Plot collections can be uploaded and viewed as a selection of images. To
-upload a plot collection, call ``hub_upload`` on the plot collection.
-
-.. code-block:: python
-
- from yt.mods import *
- pf = load("DD0252/DD0252")
- pc = PlotCollection(pf, 'c')
- pc.add_projection("Density", 0)
- pc.add_slice("Temperature", 1)
- pc.add_profile_sphere(0.2, 'unitary', ["Density", "Temperature"])
- dd = pf.h.all_data()
- pc.add_phase_object(dd, ["Density", "Temperature", "CellMassMsun"],
- weight=None)
- pc.hub_upload()
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