Update docs and release notes pre 0.7.0 release

README.rst

@@ -22,7 +22,8 @@ imaging and coronagraphic modes.
 WebbPSF also supports simulating PSFs for the upcoming Wide Field Infrared Survey Telescope (WFIRST),
 including its Wide Field Instrument and a preliminary version of the Coronagraph Instrument.
 
-Developed by Marshall Perrin, Joseph Long, Neil Zimmerman, and collaborators, 2010-2017.
+Developed by Marshall Perrin, Joseph Long, Neil Zimmerman, Robel Geda, Shannon
+Osborne, Marcio Melendez Hernandez, and collaborators, 2010-2018.
 
 Documentation can be found online at https://webbpsf.readthedocs.io
 

docs/index.rst

@@ -21,9 +21,9 @@ WebbPSF is a Python package that computes simulated PSFs for the JWST instrument
 
 **What this software does:**
 
-* Uses OPD map(s) precomputed by detailed optical simulations of these telescopes.
-* Computes from those PSF images with requested properties for any of JWST's instruments
-* Supports imaging, coronagraphy, and most spectrographic modes with all of JWST's instruments. IFUs are yet to come.
+* Uses OPD map(s) precomputed by detailed optical simulations of JWST and WFIRST, and in the case of JWST models
+  informed by instrument and telescope cryo-vacuum testing of the flight hardware.
+* For JWST, computes PSF images with requested properties for any of JWST's instruments. Supports imaging, coronagraphy, and most spectrographic modes with all of JWST's instruments. IFUs are yet to come.
 * For WFIRST, computes PSFs with the Wide Field Imager, based on recent GSFC optical models, including field- and wavelength-dependent aberrations. 
   A preliminary version of the Coronagraph Instrument is also available.
 * Provides a suite of tools for quantifying PSF properties such as FWHM, Strehl ratio, etc.
@@ -32,8 +32,11 @@ WebbPSF is a Python package that computes simulated PSFs for the JWST instrument
 
 * Contain in itself any detailed thermal or optical model of JWST or WFIRST. For the results of end-to-end integrated simulations of JWST, see for instance `Predicted JWST imaging performance (Knight, Lightsey, & Barto; Proc. SPIE 2012) <http://proceedings.spiedigitallibrary.org/proceeding.aspx?articleid=1362264>`_. For WFIRST modeling, see `the WFIRST Reference Info page <http://wfirst.gsfc.nasa.gov/science/Instrument_Reference_Information.html>`_
 * Model spectrally dispersed PSFs produced by any of the spectrograph gratings. It does, however, let you produce monochromatic PSFs in these modes, suitable for stitching together into spectra using some other software.
-* Model any detector effects such as pixel MTF, intrapixel sensitivity variations, interpixel capacitance, or any noise sources. Add those separately with your favorite detector model code.
+* Model detector effects such as pixel MTF, intrapixel sensitivity variations, interpixel capacitance, or any noise sources. Add those separately with your favorite detector model code. (\*Note, one particularly significant
+  detector scattering for MIRI imaging has now been added.)
 
+**Contributors:**
+WebbPSF has been developed by Marshall Perrin, Joseph Long, Neil Zimmerman, Robel Geda, Shannon Osborne, and Marcio Melendez Hernandez, with contributions from Jarron Leisenring, Ewan Douglas, Charles Lajoie, Megan Sosey, and the developers of  the astropy-helpers template framework.
 
 Getting Started with WebbPSF
 ----------------------------
@@ -61,7 +64,7 @@ The WebbPSF software system is composed of two Python packages: a lower-level op
 
 .. admonition:: Getting Help
 
-   For help using or installing webbpsf, you can contact the STScI Help Desk, [email protected]. Note that WebbPSF is included in the `Ureka <http://ssb.stsci.edu/ureka>`_ python distribution, as well as being installable via :ref:`standard Python packaging tools <installation>`. For detailed aspects of the JWST models, contact Marshall Perrin at STScI; for WFIRST, contact Joseph Long at STScI.
+   For help using or installing webbpsf, you can contact the STScI Help Desk, [email protected]. Note that WebbPSF is included in the Astroconda  python distribution, as well as being installable via :ref:`standard Python packaging tools <installation>`..
 
 Advanced Usage
 --------------

docs/relnotes.rst

@@ -41,10 +41,81 @@ Road Map for Future Releases
 Version History and Change Log
 -------------------------------
 
-Version 0.6.1
+Version 0.7.0
 =============
 
-*Unreleased*
+*2018 June 1*
+
+.. admonition:: Python version support
+
+    Please note, this is the _final_ release of WebbPSF to support Python 2.7. All
+    future releases will require Python 3.5+. See `here <https://python3statement.org>`_ for more information on migrating to Python 3.
+
+.. admonition:: Deprecated function names
+
+    This is also the _final_ release of WebbPSF to support the older, deprecated
+    function names with mixed case that are not compatible with the Python PEP8
+    style guide (e.g. ``calcPSF`` instead of ``calc_psf``, etc). Future versions will
+    require the use of the newer syntax.
+
+
+**General:**
+
+- Improved numerical performance in calculations, using new accelerated math functions in ``poppy``. It is highly recommended that
+  users install the ``numexpr`` package, which enables significant speed boosts in typical propagations. ``numexpr`` is easily installable
+  via Anaconda. Some use cases, particularly for coronagraphy or slit spectroscopy, can also benefit from GPU acceleration. See the latest
+  ``poppy`` release notes for more.
+
+**JWST optical model improvements:**
+
+
+- Models of field-dependent wavefront error are now included for all the SIs. The OPD information is derived from the ISIM CV3 test campaign
+  at Goddard, and is described extensively in David Aronstein et al. "Science Instrument Wavefront Error and Focus: Results Summary from the ISIM Cryogenic Vacuum Tests:",
+  JWST-RPT-032131. (See also `the SPIE paper version <http://adsabs.harvard.edu/abs/2016SPIE.9904E..09A>`_. The measured SI wavefront errors are small,
+  some tens of nanometers, and is in general less than the telescope WFE at a given location. This information is provided to help inform modeling for what
+  potential small variations in PSFs across the field of view might look like, in broad trends. However it should _not_ be taken as precise guarantee of the exact amplitudes or
+  patterns of those variations. The WFE was measured at a handful of particular field points during CV3, and the resulting Zernike coefficients are interpolated to 
+  produce _estimated_ wavefront maps at all other field points across the focal planes.  Density and precision of the available measurements vary substantially between instruments.
+  [@mperrin, with contributions from @josephoenix in prior releases, and from @robelgeda and @JarronL for the interpolation between field points. [#121, #187]
+- Added new capabilities for modeling distortions of the image planes, which cause slight deflections in the angles of diffractive features. This effect is 
+  largest for FGS, and fairly small but noticeable for the other SIs. The distortion information is taken from the Science Instrument Aperture file (SIAF) 
+  reference data maintained at STScI. As a result the ``pysiaf`` package is a new dependency required for using ``webbpsf``.  [@shanosborne]
+- For MIRI only, added new capability for modeling blurring from scattering of light within the MIRI imager detector substrate. This acts as a cross-shaped 
+  convolution kernel, strongest at the shortest wavelengths. See MIRI document MIRI-TN-00076-ATC for details on the relevant physics and detector calibration. 
+  [@shanosborne]
+- Added new capabilities for modeling mirror moves of the JWST primary segments and 
+  secondary mirror, using a linear optical model to adjust OPDs. Added a 
+  new `notebook demonstrating these capabilities <https://github.com/mperrin/webbpsf/blob/master/notebooks/Simulated%20OTE%20Mirror%20Move%20Demo.ipynb>`_. 
+  Note this code allows simulation of arbitrary mirror motions within a simplified linear range, and relies on user judgement what those mirror motions should be; it is
+  not a detailed rigorous optomechanical model of the observatory.  [Code by @mperrin, with some fixes by Geda in #185]
+- All the instrument+filter relative spectral response functions have been updated to values derived from the official validated JWST ETC reference data,
+  using the Pandeia ETC release version 1.2.2. [@mperrin]
+
+
+**WFIRST optical model improvements:**
+
+- Updates to the design Cycle 7 optical models for WFI. This includse a change in the instrument field of view layout relative to the axes, as shown
+  `here <https://github.com/mperrin/webbpsf/pull/184>`_. [`#184 <https://github.com/mperrin/webbpsf/pull/184>`_, @robelgeda]
+- Added R062 filter. 
+- Updated ``pupil_mask`` attribute for toggling between the masked and non-masked pupils now works the same way as that attribute does for the JWST instrument 
+  classes. Note, most users will not need to deal with this manually as the WFI class will by default automatically select the correct pupil based on the selected filter.
+
+
+**Bug fixes and minor changes:**
+- All JWST instruments: Added new feature for importing OPD files produced with the JWST Wavefront Analysis System software [`#208 <https://github.com/mperrin/webbpsf/pull/208>`, @skyhawk172] 
+- All JWST instruments: Fix to generalize OPD loading code to handle either compressed or uncompressed OPDs [#173, @JarronL]
+- All JWST instruments: Fix to properly load the default number of wavelengths per calculation from the filters.tsv file, rather than defaulting to 10 wavelengths regardless. [@shanosborne])
+- All JWST instrument: Fix to more correctly handle non-integer-pixel positions of the PSF when writing DET_X and DET_Y header keywords (#205, @shanosborne]
+- NIRCam and MIRI coronagraphy: Automatically set the detector coordinates and SI WFE maps based on the location of a selected coronagraph occulter. [#181, @mperrin]
+- NIRCam coronagraphy: Fix a sign error in offsets for the NIRCam coronagraph SWB occulters [#172, @mperrin]. 
+- NIRCam coronagraphy: Fix a half-percent throughput error in the round occulter masks [#206, @mperrin]
+- NIRCam coronagraphy: Fix an issue with transmission of the coronagraph bars precisely along the y axis, due to a typo [#190, @JarronL]
+- NIRCam coronagraphy: New option for shifting the coronagraph masks relative to the source, rather than vice versa. This is mostly of use for edge cases such as PSF library generation for the ETC, and is probably not of widespread utility. [#191, @mperrin]
+- NIRISS: Fix the `pupil_rotation` option so it works for NIRISS too, in particular for NRM/AMI. [#118, @mperrin]
+- NIRSpec: Very incomplete initial rudimentary support for the NIRSpec IFU, specifically just implementing the field stop for the IFU aperture. [@mperrin]
+- Updated to newer version of the astropy_helpers package infrastructure [@sosey]
+- Various smaller code cleanup and doc improvements [@mperrin, @shanosborne, @robelgeda, @douglase]
+- The ``utils.system_diagnostic`` function now checks and reports on a few more things that might be useful in diagnosing performance issues. 
 
 .. _rel0.6.0:
 

setup.py

@@ -61,7 +61,7 @@
 builtins._ASTROPY_PACKAGE_NAME_ = PACKAGENAME
 
 # VERSION should be PEP386 compatible (http://www.python.org/dev/peps/pep-0386)
-VERSION = '0.6.1.dev'
+VERSION = '0.7.0dev'
 
 # Indicates if this version is a release version
 RELEASE = 'dev' not in VERSION