[Yt-svn] commit/yt-doc: MatthewTurk: Touchups for installation and development.
Bitbucket
commits-noreply at bitbucket.org
Fri Aug 26 04:38:41 PDT 2011
1 new changeset in yt-doc:
http://bitbucket.org/yt_analysis/yt-doc/changeset/324196663f61/
changeset: 324196663f61
user: MatthewTurk
date: 2011-08-26 13:38:35
summary: Touchups for installation and development.
affected #: 3 files (816 bytes)
--- a/source/advanced/developing.rst Fri Aug 26 07:15:07 2011 -0400
+++ b/source/advanced/developing.rst Fri Aug 26 07:38:35 2011 -0400
@@ -3,6 +3,13 @@
How to Develop yt
=================
+.. note:: If you already know how to use version control and are comfortable
+ with handling it yourself, the quickest way to contribute to yt is to `fork
+ us on BitBucket <http://hg.yt-project.org/yt/fork>`, `make your changes
+ <http://mercurial.selenic.com/>`, and issue a `pull request
+ <http://hg.yt-project.org/yt/pull>`. The rest of this document is just an
+ explanation of how to do that.
+
yt is a community project!
We are very happy to accept patches, features, and bugfixes from any member of
--- a/source/advanced/installing.rst Fri Aug 26 07:15:07 2011 -0400
+++ b/source/advanced/installing.rst Fri Aug 26 07:38:35 2011 -0400
@@ -42,13 +42,13 @@
Required Libraries
++++++++++++++++++
- * Python-2.6.x or 2.7.x, but not (yet) 3.0 or higher
- * NumPy-1.1.1 or higher (including 1.5.1)
- * HDF5-1.6.10 or higher (including 1.8)
- * h5py-1.2.0
+ * Python-2.7.x, but not (yet) 3.0 or higher
+ * NumPy-1.5.1 or higher (preferably 1.5.1)
+ * HDF5-1.8.6 or higher
+ * h5py-1.3.1
* Matplotlib-1.0.0 or higher
- * Mercurial-1.5 or higher
- * Cython-0.14 or higher (for development branch of ``yt``, not stable)
+ * Mercurial-1.8 or higher
+ * Cython-0.14 or higher
Optional Libraries
++++++++++++++++++
@@ -67,10 +67,6 @@
Once you have successfully installed the dependencies, you should clone the
primary ``yt`` repository.
-.. warning:: As of early February 2011, this process has been riddled with
- errors. We currently recommend staging your download, but we are
- working to overcome these difficulties.
-
You can clone the repository with this mercurial command:
.. code-block:: bash
@@ -83,21 +79,6 @@
control history of ``yt``. If you would rather use the branch ``yt``, which is
the current development version, issue the command ``hg up -C yt`` .
-**If you run into problems with cloning** you can stage the download in this
-manner:
-
-.. code-block:: bash
-
- $ rm -rf yt-hg
- $ hg clone -r 10 http://hg.yt-project.org/yt ./yt-hg
- $ cd yt-hg
- $ wget http://yt-project.org/dependencies/yt.hg
- $ hg unbundle yt.hg
- $ hg pull
- $ hg up -C stable
-
-This should solve any issues with cloning, particularly "unexpected EOF" errors.
-
To compile ``yt``, you will have to specify the location to the HDF5 libraries,
and optionally the libpng and freetype libraries. To do so, put the "prefix"
for the installation location into the files ``hdf5.cfg`` and (optionally)
@@ -116,3 +97,37 @@
That should install ``yt`` the library as well as the commands ``iyt`` and
``yt``. Good luck!
+
+Package Management System Installation
+--------------------------------------
+
+While the installation script provides a complete stack of utilities,
+integration into your existing operating system can often be desirable.
+
+Ubuntu PPAs
++++++++++++
+
+We do not yet provide PPAs for Ubuntu, but we hope to in the near future.
+
+MacPorts
+++++++++
+
+Thomas Robitaille has kindly provided a `MacPorts <http://www.macports.org/>`_
+installation of yt, as part of his `MacPorts for Python Astronomers
+<http://astrofrog.github.com/macports-python/>`_. To activate, simply type:
+
+.. code-block:: bash
+
+ $ sudo port install py27-yt
+
+Thanks very much, Thomas!
+
+Community Installations
+-----------------------
+
+Recently, yt has been added as a module on several supercomputers. We hope to
+increase this list through partnership with supercomputer centers. You should
+be able to load an appropriate yt module on these systems:
+
+ * NICS Kraken
+ * NICS Nautilus
--- a/source/welcome_to_yt.rst Fri Aug 26 07:15:07 2011 -0400
+++ b/source/welcome_to_yt.rst Fri Aug 26 07:38:35 2011 -0400
@@ -17,15 +17,16 @@
yt was designed to be a completely Free (as in beer *and* as in freedom --
"free and libre" as the saying goes) user-extensible framework for analyzing
-and visualizing adaptive mesh refinement data, currently working with both Enzo
-and Orion data. It relies on no proprietary software -- although it can be and
-has been extended to interface with proprietary software and libraries -- and
-has been designed from the ground up to enable users to be as immersed in the
-data as they desire.
+and visualizing astrophysical data, currently working with several different
+codes, including the "flagship" codes Enzo, Orion, Nyx and FLASH. It relies on
+no proprietary software -- although it can be and has been extended to
+interface with proprietary software and libraries -- and has been designed from
+the ground up to enable users to be as immersed in the data as they desire.
-yt is currently being developed by a team of developers, including me, Britton
-Smith, Jeff Oishi, Stephen Skory, Sam Skillman, Devin Silvia, John Wise, David
-Collins, Christopher Moody, Oliver Hahn, and John ZuHone. All development is
+yt is currently being developed by a team of developers. We used to include
+the entire list here, but it got too long, so now the best place to find it is
+to take a look at the current `CREDITS
+<http://hg.yt-project.org/yt/src/yt/CREDITS>` file. All development is
conducted in the open, accessible at http://yt-project.org/ .
What functionality does yt offer?
@@ -76,10 +77,12 @@
* Command-line tools
- * Zooming movies
* Time-series movies
* HOP Halo Finding
* Quick slice and projection images
+ * Mapserver
+ * Bug reports
+ * IPython frontend
* Access to components
@@ -90,9 +93,10 @@
How do I cite yt?
-----------------
-If you use some of the advanced features of yt and would like to cite it in
-a publication, you should feel free to cite the
-`ApJS paper <http://arxiv.org/abs/1011.3514>`_ with the following BibTeX entry: ::
+If you use some of the advanced features of yt and would like to cite it in a
+publication, you should feel free to cite the `ApJS paper
+<http://adsabs.harvard.edu/abs/2011ApJS..192....9T>`_ with the following BibTeX
+entry: ::
@ARTICLE{2011ApJS..192....9T,
author = {{Turk}, M.~J. and {Smith}, B.~D. and {Oishi}, J.~S. and {Skory}, S. and
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