Adding release docs and updating citation information.

--HG--
branch : week-of-code

Author: Nathan Goldbaum

CITATION

@@ -0,0 +1,45 @@
+To cite Enzo in publications, please use:
+
+Bryan, G.~L., Norman, M.~L., O'Shea, B.~W., et al. 2014, ApJS, 211, 19
+
+In the body of the text, please add a footnote to the enzo webpage:
+
+http://enzo-project.org
+
+and in the acknowledgements, please add the following text:
+
+"Computations described in this work were performed using the publicly-available
+\texttt{Enzo} code (http://enzo-project.org), which is the product of a
+collaborative effort of many independent scientists from numerous institutions
+around the world.  Their commitment to open science has helped make this work
+possible."
+
+Here are some alternative citation formats for For LaTeX and BibTex users:
+
+\bibitem[Bryan et al.(2014)]{2014ApJS..211...19B} Bryan, G.~L., Norman, 
+M.~L., O'Shea, B.~W., et al.\ 2014, \apjs, 211, 19 
+
+@ARTICLE{2014ApJS..211...19B,
+   author = {{Bryan}, G.~L. and {Norman}, M.~L. and {O'Shea}, B.~W. and {Abel}, T. and 
+   {Wise}, J.~H. and {Turk}, M.~J. and {Reynolds}, D.~R. and {Collins}, D.~C. and 
+   {Wang}, P. and {Skillman}, S.~W. and {Smith}, B. and {Harkness}, R.~P. and 
+   {Bordner}, J. and {Kim}, J.-h. and {Kuhlen}, M. and {Xu}, H. and 
+   {Goldbaum}, N. and {Hummels}, C. and {Kritsuk}, A.~G. and {Tasker}, E. and 
+   {Skory}, S. and {Simpson}, C.~M. and {Hahn}, O. and {Oishi}, J.~S. and 
+   {So}, G.~C. and {Zhao}, F. and {Cen}, R. and {Li}, Y. and {The Enzo Collaboration}
+   },
+    title = "{ENZO: An Adaptive Mesh Refinement Code for Astrophysics}",
+  journal = {\apjs},
+archivePrefix = "arXiv",
+   eprint = {1307.2265},
+ primaryClass = "astro-ph.IM",
+ keywords = {hydrodynamics, methods: numerical },
+     year = 2014,
+    month = apr,
+   volume = 211,
+      eid = {19},
+    pages = {19},
+      doi = {10.1088/0067-0049/211/2/19},
+   adsurl = {http://adsabs.harvard.edu/abs/2014ApJS..211...19B},
+  adsnote = {Provided by the SAO/NASA Astrophysics Data System}
+}

doc/manual/source/conf.py

@@ -50,9 +50,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '2.3'
+version = '2.4'
 # The full version, including alpha/beta/rc tags.
-release = '2.3'
+release = '2.4'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -221,7 +221,7 @@
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {'http://docs.python.org/': None,
-                       'http://ipython.scipy.org/doc/manual/html/': None,
+                       'http://ipython.org/ipython-doc/stable/': None,
                        'http://docs.scipy.org/doc/numpy/': None,
                        'http://matplotlib.sourceforge.net/': None,
                        'http://yt.enzotools.org/doc': None,

doc/manual/source/developer_guide/DoingARelease.rst

@@ -0,0 +1,58 @@
+.. _DoingARelease:
+
+Doing a Release
+===============
+
+Periodically, the Enzo community creates an "official" release of the Enzo
+codebase.  While running off of the Enzo mercurial repository is in general
+quite stable, doing official releases has other benefits.  By doing releases, we
+acoomplish the following goals:
+
+* Periodically recognize the breadth and depth of the code contributions by our
+  community.
+* Offer a "stable" platform with known properties to test against for people who
+  are not heavily involved in Enzo development.
+* Announce to the wider computational astrophysics community about ongoing
+  developments in the Enzo codebase.
+
+Generally, releases happen via the contributions of a release manager and the
+author of the release e-mail.  
+
+Generally, the release manager is a senior member of the community whose
+responsibility is to ensure open pull requests are integrated into the code
+before the release, select a release e-mail author, and ensure that the
+checklist in this document is carried out.
+
+The author of the release e-mail is generally someone who has made significant
+recent contributions to the code.  This person may be at any seniority level,
+although in the past several releases (as of Enzo 2.4) this person has generally
+been either a postdoc or a grad student.
+
+To do the release, the following tasks must be completed:
+
+* Update the ``README`` file in the root of the repository to reflect the
+  current version. Also look over the document to correct any changes to
+  repository locations, mailing list or social media addresses, or new
+  contributors.
+
+* Update the ``CHANGELOG`` to include a new entry for the release.  The
+  demarcation between new features, enhancements, or bugfixes is up to the
+  judgement of the release manager. Use the following format::
+
+   == Version 2.x ==
+   _Release Date: 1/19/2038
+ 
+   * New Feature: A frobulator was added to the code to improve frobulation.
+                  (PR xxx)
+   * Enhancement: The moving mesh module now supports 11-dimensional meshes.
+                  (PR YYY)
+   * Bugfix: The retro-encabulator no longer instantiates sentient AIs. 
+             (PR ZZZ)
+  
+* Update the ``conf.py`` file in the documentation to include the new version
+  number.
+
+* Ensure that the answer tests are passing on the automated build machine.
+
+* Once all pull requests slated for the release have been merged, tag the final
+  commit as the "enzo-2.x" release changeset.

doc/manual/source/developer_guide/index.rst

@@ -27,3 +27,4 @@ of AMR and numerical methods is assumed throughout this documentation.
    NewTestProblem1.rst
    NewTestProblem3.rst
    using_mhd.rst
+   DoingARelease.rst

doc/manual/source/index.rst

@@ -95,12 +95,21 @@ release and routinely by Enzo developers.
 Citing Enzo
 -----------
 
+Guidelines for citing enzo are available in the ``CITATION`` file in the root of
+the enzo mercurial repository.
+
 If you use Enzo for a scientific publication, we ask that you cite the code in
-the following way in the acknowledgments of your paper:
+the following way in the acknowledgments of your paper::
+
+    Computations described in this work were performed using the
+    publicly-available \texttt{Enzo} code (http://enzo-project.org), which is
+    the product of a collaborative effort of many independent scientists from
+    numerous institutions around the world.  Their commitment to open science
+    has helped make this work possible.
 
-Computations described in this work were performed using the Enzo code
-(http://enzo-project.org), which is the product of a collaborative effort
-of scientists at many universities and national laboratories.
+In addition, we request that you link to the project webpage in a footnote and
+add a citation to the Enzo method paper.  See the ``CITATION`` file for BibTeX
+and LaTeX formatted citations.
 
 Search
 ======