[yt-svn] commit/yt-doc: 6 new changesets
Bitbucket
commits-noreply at bitbucket.org
Wed Feb 1 16:08:29 PST 2012
6 new commits in yt-doc:
https://bitbucket.org/yt_analysis/yt-doc/changeset/7e8695f298e6/
changeset: 7e8695f298e6
user: chummels
date: 2012-01-26 16:59:50
summary: Showing how to manually update your code base. Also added a section in how to switch between different branches of the code.
affected #: 1 file
diff -r dcbe2bcadb649cf7bbc0978b504831cbe25aaf2b -r 7e8695f298e6cdf63b3857d34c7ee6bb043a4fe7 source/advanced/installing.rst
--- a/source/advanced/installing.rst
+++ b/source/advanced/installing.rst
@@ -157,15 +157,50 @@
This script will identify which repository you're using (stable, development,
etc.), connect to the yt-project.org server, download any recent changesets
-for your version, and then recompile any new code that needs it (e.g. cython,
-rebuild).
+for your version and then recompile any new code that needs
+it (e.g. cython, rebuild). This same behavior is achieved manually by running:
+
+.. code-block:: bash
+
+ $ cd $YT_DEST/src/yt-hg
+ $ hg pull
+ $ python setup.py develop
Note that this automated update will fail if you have made modifications to
the yt code base that you have not yet committed. If this occurs, identify
your modifications using 'hg status', and then commit them using 'hg commit',
in order to bring the repository back to a state where you can automatically
-update the code as above.
-
+update the code as above. On the other hand, if you want to wipe out your
+uncommitted changes and just update to the latest version, you can type:
+
+.. code-block:: bash
+
+ $ cd $YT_DEST/src/yt-hg
+ $ hg pull
+ $ hg up -C # N.B. This will wipe your uncommitted changes!
+ $ python setup.py develop
+
If you run into *any* problems with the update utility, it should be considered
a bug, and we would love to hear about it so we can fix it. Please inform us
through the bugsubmit utility or through the yt-users mailing list.
+
+Switching Between Branches in yt
+================================
+
+.. _switching-versions:
+
+If you are running the stable version of the code, and you want to switch
+to using the development version of the code (or vice versa), you can merely
+follow a few steps (without reinstalling all of the source again):
+
+.. code-block:: bash
+
+ $ cd $YT_DEST/src/yt-hg
+ $ hg pull
+ <commit all changes or they will be lost>
+ $ hg up -C <branch> # N.B. This will wipe your uncommitted changes!
+ $ python setup.py develop
+
+If you want to switch to using the development version of the code, use:
+"yt" as <branch>, whereas if you want to switch to using the stable version
+of the code, use: "stable" as <branch>.
https://bitbucket.org/yt_analysis/yt-doc/changeset/d017016e0940/
changeset: d017016e0940
user: chummels
date: 2012-01-26 17:11:42
summary: Updating all of the command-line option documentation.
affected #: 1 file
diff -r 7e8695f298e6cdf63b3857d34c7ee6bb043a4fe7 -r d017016e0940b39373c039bc32ff9f7515dd1488 source/interacting/command-line.rst
--- a/source/interacting/command-line.rst
+++ b/source/interacting/command-line.rst
@@ -14,12 +14,19 @@
yt -h
-This yields all of the subcommands. To execute any subcommand, simply run:
+This yields all of the subcommands. To execute any such function,
+simply run:
.. code-block:: bash
yt <subcommand>
+Finally, to identify the options associated with any of these subcommand, run:
+
+.. code-block:: bash
+
+ yt <subcommand> -h
+
Let's go through each subcommand.
.. code-block:: bash
@@ -39,6 +46,7 @@
pasteboard_grab Download from your or another user's pasteboard
plot Create a set of images
rpdb Connect to a currently running (on localhost) rpd ses...
+ reason Run the Web GUI Reason
serve Run the Web GUI Reason
stats Print stats and maximum density for one or more datasets
update Update the yt installation to the most recent version
@@ -48,7 +56,7 @@
+++++++++++++
After you have installed yt and you want to do some development, there may
-be a few more steps to complete. This function automates building a
+be a few more steps to complete. This subcommand automates building a
development environment for you by setting up your hg preferences correctly,
creating/linking to a bitbucket account for hosting and sharing your code,
and setting up a pasteboard for your code snippets. A full description of
@@ -76,12 +84,7 @@
help
++++
-Help behaves as you expect that it might. You can use it with any other
-command-line option to find out more details or if it has any flags:
-
-.. code-block:: bash
-
- yt help <subcommand>
+Help lists all of the various command-line options in yt.
hop
+++
@@ -147,7 +150,8 @@
yt pastebin my_script.py
By running the ``pastebin_grab`` subcommand with a pastebin number
-(e.g. 1768), it will grab the contents of that pastebin and send it to
+(e.g. 1768), it will grab the contents of that pastebin
+(e.g. the website http://paste.yt-project.org/show/1768 ) and send it to
STDOUT for local use. For more details see the :ref:`pastebin` section.
.. code-block:: bash
@@ -175,7 +179,7 @@
render
++++++
-This command generates a volume rendering for a single dataset. By sepcifying
+This command generates a volume rendering for a single dataset. By specifying
the center, width, number of pixels, number and thickness of contours, etc.
(run ``yt help render`` for details), you can create high-quality volume
renderings at the command-line before moving on to more involved volume
@@ -186,10 +190,11 @@
Connect to a currently running (on localhost) rpd session.
-serve
-+++++
+reason and serve
+++++++++++++++++
-The ``serve`` subcommand initiates the Web GUI Reason. See :ref:`reason`.
+The ``reason`` and ``serve`` subcommands have identical functionality in that
+they both initiate the Web GUI Reason. See :ref:`reason`.
stats
+++++
https://bitbucket.org/yt_analysis/yt-doc/changeset/fd4e8886c68c/
changeset: fd4e8886c68c
user: chummels
date: 2012-01-26 22:04:38
summary: Updating command-line options to be in line with those actually offered in
code.
affected #: 1 file
diff -r d017016e0940b39373c039bc32ff9f7515dd1488 -r fd4e8886c68ca7fd7edaa8c9132db0d7b4ff8233 source/interacting/command-line.rst
--- a/source/interacting/command-line.rst
+++ b/source/interacting/command-line.rst
@@ -31,26 +31,34 @@
.. code-block:: bash
- bootstrap_dev Bootstrap a yt development environment
- bugreport Report a bug in yt
- halos Run HaloProfiler on one dataset
- help (?, h) give detailed help on a specific sub-command
- hop Run HOP on one or more datasets
- hubsubmit Submit a mercurial repository to the yt Hub (http://h...
- instinfo Get some information about the yt installation
- load Load a single dataset into an IPython instance
- mapserver Serve a plot in a GMaps-style interface
- pastebin Post a script to an anonymous pastebin
- pastebin_grab Print an online pastebin to STDOUT for local use. Pas...
- pasteboard Place a file into your pasteboard.
- pasteboard_grab Download from your or another user's pasteboard
- plot Create a set of images
- rpdb Connect to a currently running (on localhost) rpd ses...
- reason Run the Web GUI Reason
- serve Run the Web GUI Reason
- stats Print stats and maximum density for one or more datasets
- update Update the yt installation to the most recent version
- upload_image Upload an image to imgur.com. Must be PNG.
+ help Print help message
+ bootstrap_dev Bootstrap a yt development environment
+ bugreport Report a bug in yt
+ hop Run HOP on one or more datasets
+ hub_submit Submit a mercurial repository to the yt Hub
+ (http://hub.yt-project.org/), creating a BitBucket
+ repo in the process if necessary.
+ instinfo Get some information about the yt installation
+ load Load a single dataset into an IPython instance
+ mapserver Serve a plot in a GMaps-style interface
+ pastebin Post a script to an anonymous pastebin
+ pastebin_grab Print an online pastebin to STDOUT for local use.
+ Paste ID is the number at the end of the url.
+ plot Create a set of images
+ reason Run the Web GUI Reason
+ render Create a simple volume rendering
+ rpdb Connect to a currently running (on localhost) rpd
+ session. Commands run with --rpdb will trigger an rpdb
+ session with any uncaught exceptions.
+ serve Run the Web GUI Reason
+ stats Print stats and max density for one or more datasets
+ update Update the yt installation to the most recent version
+ upload_image Upload an image to imgur.com. Must be PNG.
+
+help
+++++
+
+Help lists all of the various command-line options in yt.
bootstrap_dev
+++++++++++++
@@ -72,20 +80,6 @@
making a mistake (see :ref:`asking-for-help`), you can submit bug
reports using this nice utility.
-halos
-+++++
-
-You can easily run the HaloProfiler utility on a single dataset, in order
-to analyze and visualize multiple halos in a simulation simultaneously and
-homogeneously. For more information about the HaloProfiler see
-:ref:`halo_profiling`; for its command line flags, use the help command
-with the halos keyword.
-
-help
-++++
-
-Help lists all of the various command-line options in yt.
-
hop
+++
@@ -158,16 +152,6 @@
yt pastebin_grab 1768
-pasteboard and pasteboard_grab
-++++++++++++++++++++++++++++++
-
-The pasteboard is very similar to the pastebin, except that it is not
-anonymous. It is a place you can put more polished code that you'd like
-to share with others. It might be code that is a step down from what you
-might share on the `yt hub <http://hub.yt-project.org/>`_. Of course,
-you will only have a pasteboard if you've created a development environment
-using the bootstrap-dev subcommand.
-
plot
++++
@@ -176,6 +160,12 @@
details), you can create slices and projections easily at the
command-line.
+reason and serve
+++++++++++++++++
+
+The ``reason`` and ``serve`` subcommands have identical functionality in that
+they both initiate the Web GUI Reason. See :ref:`reason`.
+
render
++++++
@@ -190,12 +180,6 @@
Connect to a currently running (on localhost) rpd session.
-reason and serve
-++++++++++++++++
-
-The ``reason`` and ``serve`` subcommands have identical functionality in that
-they both initiate the Web GUI Reason. See :ref:`reason`.
-
stats
+++++
https://bitbucket.org/yt_analysis/yt-doc/changeset/490c6defebf7/
changeset: 490c6defebf7
user: chummels
date: 2012-01-27 00:45:59
summary: Adding entry to the faq about manually building yt.
affected #: 1 file
diff -r fd4e8886c68ca7fd7edaa8c9132db0d7b4ff8233 -r 490c6defebf72b918584d35bf65bb47b694055aa source/faq/index.rst
--- a/source/faq/index.rst
+++ b/source/faq/index.rst
@@ -118,6 +118,17 @@
build and install from source and specify the mpi-enabled c and c++
compilers in the mpi.cfg file. See the `mpi4py installation page <http://mpi4py.scipy.org/docs/usrman/install.html>`_ for details.
+``yt`` fails saying that it cannot import yt modules
+----------------------------------------------------
+
+This is likely because you need to rebuild the source. You can do
+this automatically by running:
+
+.. code-block:: bash
+
+ cd $YT_DEST/src/yt-hg
+ python setup.py develop
+
How do I cite yt?
-----------------
https://bitbucket.org/yt_analysis/yt-doc/changeset/61f315153502/
changeset: 61f315153502
user: chummels
date: 2012-01-27 00:46:37
summary: Merging.
affected #: 1 file
diff -r 490c6defebf72b918584d35bf65bb47b694055aa -r 61f3151535027fc8a2afae3ebc9478406c76aaed source/advanced/parallel_computation.rst
--- a/source/advanced/parallel_computation.rst
+++ b/source/advanced/parallel_computation.rst
@@ -338,7 +338,7 @@
the job scheduler queue; it may be worth trying to find it.
* If you are using object-based parallelism but doing CPU-intensive computations
- on each object, you may find that setting :py:data:'num_procs' equal to the
+ on each object, you may find that setting ``num_procs`` equal to the
number of processors per compute node can lead to significant speedups.
By default, most mpi implimentations will assign tasks to processors on a
'by-slot' basis, so this setting will tell yt to do computations on a single
https://bitbucket.org/yt_analysis/yt-doc/changeset/da2a64cca984/
changeset: da2a64cca984
user: chummels
date: 2012-01-27 00:48:49
summary: Updating command-line list doc.
affected #: 1 file
diff -r 61f3151535027fc8a2afae3ebc9478406c76aaed -r da2a64cca9843cdd4a1f3c46843adff831ab1089 source/interacting/command-line.rst
--- a/source/interacting/command-line.rst
+++ b/source/interacting/command-line.rst
@@ -41,9 +41,8 @@
instinfo Get some information about the yt installation
load Load a single dataset into an IPython instance
mapserver Serve a plot in a GMaps-style interface
- pastebin Post a script to an anonymous pastebin
+ pastebin Post a script to an anonymous pastebin
pastebin_grab Print an online pastebin to STDOUT for local use.
- Paste ID is the number at the end of the url.
plot Create a set of images
reason Run the Web GUI Reason
render Create a simple volume rendering
@@ -55,6 +54,7 @@
update Update the yt installation to the most recent version
upload_image Upload an image to imgur.com. Must be PNG.
+
help
++++
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