update docs for release

sncosmo · Dec 1, 2015 · b42f060 · b42f060
1 parent 70a0b35
commit b42f060
Show file tree

Hide file tree

Showing 8 changed files with 64 additions and 30 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,4 @@
-1.2.0 (unreleased)
-------------------
+THIS FILE NO LONGER MAINTAINED. See docs/whatsnew.rst instead.
 
 1.1.1 (2015-10-28)
 ------------------

diff --git a/docs/about.rst b/docs/about.rst
@@ -5,28 +5,25 @@ About SNCosmo
 Package Features
 ================
 
-- **SN models:** Synthesize supernova spectra and photometry from SN models.
+- **SN models:** Synthesize supernova spectra and photometry from SN
+  models.
 
 - **Fitting and sampling:** Functions for fitting and sampling SN
   model parameters given photometric light curve data.
 
 - **Dust laws:** Fast implementations of several commonly used
-  extinction laws; can be used to construct SN models including dust.
+  extinction laws; can be used to construct SN models that include dust.
 
-- **I/O:** Convenience functions for reading and writing peculiar data formats
-  used in other packages and getting dust values from SFD (1998) maps.
+- **I/O:** Convenience functions for reading and writing peculiar data
+  formats used in other packages and getting dust values from
+  SFD (1998) maps.
 
-- **Built-in supernova models** such as the Hsiao, Nugent, PSNID,
-  SNANA and Whalen models, as well as a variety of built-in bandpasses
-  and magnitude systems.
+- **Built-in supernova models** such as SALT2, MLCS2k2, Hsiao, Nugent,
+  PSNID, SNANA and Whalen models, as well as a variety of built-in
+  bandpasses and magnitude systems.
 
-- **Extensible:** New models, bandpasses, and
-  magnitude systems can be defined, using an object-oriented interface.
-
-- **Fast:** Fully NumPy-ified and profiled. Generating
-  synthetic photometry for 100 observations spread between four
-  bandpasses takes on the order of 2 milliseconds (depends on model
-  and bandpass sampling).
+- **Extensible:** New models, bandpasses, and magnitude systems can be
+  defined, using an object-oriented interface.
 
 
 Relation to other SN cosmology software
@@ -46,8 +43,10 @@ supernova cosmology. These include (but are not limited to) `snfit`_
   aspects of SN analyses.
 
 * `SNooPy`_ (or snpy) is also a Python library for SN analysis, but
-  with a (mostly) different feature set. The current maintenance and
-  development status of the package is unclear.
+  with a (mostly) different feature set. SNCosmo is based on spectral
+  timeseries models whereas SNooPy is more focussed on models of light
+  curves in given bands.
+
 
 .. _`snfit`: http://supernovae.in2p3.fr/salt
 .. _`SNANA`: http://sdssdp62.fnal.gov/sdsssn/SNANA-PUBLIC/
@@ -67,13 +66,17 @@ science (radiative transfer simulations for instance).  Hence
 Contributors
 ============
 
+Alphabetical by last name:
+
 * Kyle Barbary
+* Tom Barclay
 * Rahul Biswas
+* Matt Craig
+* Ulrich Feindt
+* Brian Friesen
+* Danny Goldstein
+* Saurabh Jha
 * Steve Rodney
 * Caroline Sofiatti
-* Tom Barclay
 * Rollin C. Thomas
-* Danny Goldstein
 * Michael Wood-Vasey
-* Brian Friesen
-* Matt Craig
diff --git a/docs/conf.py b/docs/conf.py
@@ -54,7 +54,7 @@
 # This does not *have* to match the package name, but typically does
 project = u'sncosmo'
 author = u'Kyle Barbary and contributors'
-copyright = u'2014, ' + author
+copyright = u'2013-2015, ' + author
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

diff --git a/docs/contributing.rst b/docs/contributing.rst
@@ -169,15 +169,12 @@ These are notes mainly for the one person that manages releases.
 Yes, this could be more automated, but it isn't done very often,
 and involves some human verification.
 
-- Ensure that ``CHANGES.md`` is up-to-date and add version date.
-- Update ``docs/whatsnew.rst`` by copying text from ``CHANGES.md``,
-  then altering formatting and adding text as needed.
+- Update ``docs/whatsnew.rst`` with a summary of the new version's changes.
 - Bump version in ``setup.py``.
 - Check copyright year in ``docs/conf.py``.
 - Build package and docs and check that docs look good.
 - Commit.
 - ``git clean -dfx``
-- ``setup.py build``
 - ``setup.py sdist``
 - Check that the tarball in ``dist/`` can be unpacked and
   that ``setup.py test`` succeeds. Bonus: create a fresh conda

diff --git a/docs/index.rst b/docs/index.rst
@@ -35,7 +35,6 @@ possible. It is built on NumPy, SciPy and AstroPy.
 * Check out the source code: https://github.com/sncosmo/sncosmo
 * Report bugs, request features: https://github.com/sncosmo/sncosmo/issues
 * User & developer mailing list: https://groups.google.com/forum/#!forum/sncosmo
-* Contact the main author directly: Use kylebarbary [at] gmail [dot] com
 
 Usage
 =====

diff --git a/docs/install.rst b/docs/install.rst
@@ -11,10 +11,15 @@ AstroPy_.
 Install using conda
 ===================
 
-SNCosmo is available on the astropy channel::
+SNCosmo is available on the `astropy channel <https://anaconda.org/astropy/>`_::
 
     conda install -c astropy sncosmo
 
+The release of the conda version may lag behind the pip release, so
+you may want to check the available conda version. You can do this
+at the link above, or by running ``conda search -c astropy sncosmo``.
+
+
 Install using pip
 =================
 

diff --git a/docs/whatsnew.rst b/docs/whatsnew.rst
@@ -5,6 +5,37 @@ What's New
 *Note:* SNCosmo uses `Semantic Versioning <http://semver.org>`_ for its version
 numbers.
 
+What's new in v1.2.0 (2015-12-01)
+=================================
+
+API Changes
+-----------
+
+- Registry functions moved to the top-level namespace:
+
+  - ``sncosmo.registry.register()`` -> ``sncosmo.register()``
+  - ``sncosmo.registry.register_loader()`` -> ``sncosmo.register_loader()``
+  - ``sncosmo.registry.retrieve()`` -> deprecated, use class-specific functions such as ``sncosmo.get_bandpass()``.
+
+  The old import paths will still work, so this is backwards compatible.
+
+Enhancements
+------------
+
+- ``nest_lc()`` now uses the ``nestle`` module under the hood. A new
+  keyword ``method`` is available which selects different sampling
+  methods implemented by ``nestle``. The new methods provide potential
+  efficiency gains.
+- The MLCS2k2 model is now available as a built-in Source, with the
+  name ``'mlcs2k2'``.
+- Bandpasses from the Carnegie Supernova Project added to built-ins.
+- In ``realize_lcs()``, a new ``scatter`` keyword makes adding noise
+  optional.
+
+In addition, there have been several minor bug fixes and
+documentation improvements.
+
+
 What's new in v1.1.1 (2015-10-28)
 =================================
 

diff --git a/setup.py b/setup.py
@@ -52,7 +52,7 @@ def recursive_glob(basedir, pattern):
 builtins._ASTROPY_PACKAGE_NAME_ = PACKAGENAME
 
 # VERSION should be PEP386 compatible (http://www.python.org/dev/peps/pep-0386)
-VERSION = '1.2.dev'
+VERSION = '1.2.0'
 
 # Indicates if this version is a release version
 RELEASE = 'dev' not in VERSION