[yt-svn] commit/yt-doc: 2 new changesets
Bitbucket
commits-noreply at bitbucket.org
Wed Aug 1 15:09:26 PDT 2012
2 new commits in yt-doc:
https://bitbucket.org/yt_analysis/yt-doc/changeset/cd383f99a585/
changeset: cd383f99a585
user: MatthewTurk
date: 2012-08-01 23:55:44
summary: Adding a bit about the hub.
affected #: 2 files
diff -r a4fc9e5a1b8c54fa103dcca791e9666d022f2e07 -r cd383f99a585d5e7def1d41ea97771b8f3bb721a source/interacting/index.rst
--- a/source/interacting/index.rst
+++ b/source/interacting/index.rst
@@ -15,4 +15,5 @@
command-line
reason
mapserver
+ sharing_data_hub
paraview
diff -r a4fc9e5a1b8c54fa103dcca791e9666d022f2e07 -r cd383f99a585d5e7def1d41ea97771b8f3bb721a source/interacting/sharing_data_hub.rst
--- /dev/null
+++ b/source/interacting/sharing_data_hub.rst
@@ -0,0 +1,108 @@
+Sharing Data on 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()
https://bitbucket.org/yt_analysis/yt-doc/changeset/63fc1191aba8/
changeset: 63fc1191aba8
user: ngoldbaum
date: 2012-08-02 00:09:25
summary: Merged in MatthewTurk/yt-doc (pull request #48)
affected #: 2 files
diff -r 51f8f9525e6447418a81467e03c2d3a7865308fd -r 63fc1191aba8d3ccd33f504779c02ceb8414edf8 source/interacting/index.rst
--- a/source/interacting/index.rst
+++ b/source/interacting/index.rst
@@ -15,4 +15,5 @@
command-line
reason
mapserver
+ sharing_data_hub
paraview
diff -r 51f8f9525e6447418a81467e03c2d3a7865308fd -r 63fc1191aba8d3ccd33f504779c02ceb8414edf8 source/interacting/sharing_data_hub.rst
--- /dev/null
+++ b/source/interacting/sharing_data_hub.rst
@@ -0,0 +1,108 @@
+Sharing Data on 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