Merge pull request #563 from BradleySappington/release_prep

Release prep
spacetelescope · May 12, 2023 · 9dbabfd · 9dbabfd
2 parents beec6d9 + ef51b2e
commit 9dbabfd
Show file tree

Hide file tree

Showing 17 changed files with 699 additions and 593 deletions.
diff --git a/docs/about.rst b/docs/about.rst
@@ -25,7 +25,7 @@ POPPY is developed primarily by a team of astronomers at the `Space Telescope
 Science Institute <http://www.stsci.edu/>`_, but is open to contributions from
 scientists and software developers around the world. Development takes place
 on Github at http://github.com/spacetelescope/poppy. See that page for the most up-to-date
-list of contributors. 
+list of contributors.
 
 Direct contributors to POPPY code
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -53,6 +53,10 @@ Direct contributors to POPPY code
  * Kim Ward-Duong (:user:`spacegal-spiff`)
  * Greg Brady (:user:`grbrady`)
  * Kian Milani (:user:`kian1377`)
+ * Evan Mayer (:user:`evanmayer`)
+ * Adam Bolton (:user:`adambolton`)
+ * Bradley Sappington (:user:`BradleySappington`)
+ * Zachary Burnett(:user:`zacharyburnett`)
 
 Indirect Contributors (algorithms, advice, ideas, inspirations)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

diff --git a/docs/available_optics.ipynb b/docs/available_optics.ipynb
diff --git a/docs/dev_notes.rst b/docs/dev_notes.rst
@@ -5,7 +5,7 @@ Appendix C: Developer Notes and Release Procedure
 Release Process
 ---------------
 
-#. Get the `develop` branch to the state you would like for the release. This includes all tests passing, both on Travis and locally via tox.
+#. Get the `develop` branch to the state you would like for the release. This includes all tests passing, both on Github Actions and locally via tox.
 #. Locally, checkout the `develop` branch and ensure it's current with respect to Github.
 #. Tag the latest commit in `develop` with `v<version>`, being sure to sign the tag with the `-s` option. (You will need to ensure you have git commit signing via GPG setup prior to this).
    * ``git tag -s v<version> -m "Release v<version>"``
@@ -21,9 +21,9 @@ Release Process
    #. Specify the version number, title, and brief description of the release.
    #. Press "Publish Release".
 
-#. Release to PyPI. This should now happen automatically on Travis. This is triggered by a Travis build of a tagged commit on the `stable` branch, so should happen automatically after the PR to `stable`.
+#. Release to PyPI. This should now happen automatically on Github Actions. This is triggered by a Github Actions build of a tagged commit on the `stable` branch, so should happen automatically after the PR to `stable`.
 
-#. Release to AstroConda, via steps below.
+#. Release to AstroConda, via steps below. (Currently deprecated, awaiting transfer to Stenv to update this process)
 
 Releasing a new version through AstroConda
 ------------------------------------------

diff --git a/docs/extending.rst b/docs/extending.rst
@@ -119,14 +119,14 @@ The spatial or angular scale of these arrays must also be indicated by a FITS
 header keyword. By default, poppy checks for the keyword `PIXSCALE` for image
 plane pixel scale in arcseconds/pixel or `PUPLSCAL` for pupil plane scale in
 meters/pixel. However if your FITS file uses some alternate keyword, you can specify that
-keyword name with the `pupilscale=` argument in the call to the `~poppy.FITSOpticalElement` constructor, i.e.::
+keyword name with the `pixelscale=` argument in the call to the `~poppy.FITSOpticalElement` constructor, i.e.::
 
-     myoptic = poppy.FITSOpticalElement(transmission='transfile.fits', opd='opdfile.fits', pupilscale="PIXELSCL")
+     myoptic = poppy.FITSOpticalElement(transmission='transfile.fits', opd='opdfile.fits', pixelscale="PIXELSCL")
 
 
 Lastly if there is no such keyword available, you can specify the numerical scale directly via the same keyword by providing a float instead of a string::
 
-     myoptic = poppy.FITSOpticalElement(transmission='transfile.fits', opd='opdfile.fits', pupilscale=0.020)
+     myoptic = poppy.FITSOpticalElement(transmission='transfile.fits', opd='opdfile.fits', pixelscale=0.020)
 
 
 Creating a custom instrument

diff --git a/docs/fresnel.rst b/docs/fresnel.rst
@@ -39,6 +39,7 @@ The Fresnel propagation API necessarily differs in several ways from the origina
 First, when we define a Fresnel wavefront, the first argument specifies the desired diameter of the wavefront, and must be given as an `astropy.Quantity <http://docs.astropy.org/en/stable/units/>`_ of dimension length::
 
         import astropy.units as u
+        npix = 256
         wf_fresnel = poppy.FresnelWavefront(0.5*u.m,wavelength=2200e-9,npix=npix,oversample=4)
         # versus:
         wf_fraunhofer = poppy.Wavefront(diam=0.5, wavelength=2200e-9,npix=npix,oversample=4)

diff --git a/docs/relnotes.rst b/docs/relnotes.rst
@@ -5,23 +5,36 @@ Release Notes
 
 For a list of contributors, see :ref:`about`.
 
-.. _rel1.1.0:
-
 1.1.0
 -----
 
-This release introduces support for much faster (20-80x) optical calculations using GPU acceleration via the CuPy library for NVidia GPUs. Credit to Kian Milani (:user:`kian1337`) for this significant and complex improvement. 
-
-
-*2023 date TBD*
+.. _rel1.1.0:
 
- **Performance Enhancements:**
-  * Implement CuPy GPU acceleration for calculations throughout poppy. (PR :pr:`499` by :user:`kian1377` and :user:`mperrin`)
+ *2023 May 12*
 
- **Software Infrastructure Updates and Internals:**
-  * Increase all CI test versions by 1, removing Python 3.8 and adding Python 3.11. Update minimum supported versions of astropy and numpy as well. (PR :pr:`551` by :user:`BradleySappington`)
-  * Updates to dependencies (various PRs)
-  * Bug fix for a recent change in numpy interface (:pr:`545` by :user:`adambolton`)
+**Software Infrastructure Updates and Internals:**
+ * Increase all CI test versions by 1, removing Python 3.8 and adding Python 3.11. Update minimum supported versions of astropy and numpy as well.
+ * Updated ReadTheDocs build's Python version by :user:`ojustino` in :pr:`512`
+ * Tried Python 3.8 with ReadTheDocs instead by :user:`ojustino` in :pr:`514`
+ * Fix position angle rotation passthrough for TiltOpticalPathDifference by :user:`evanmayer` in :pr:`524`
+ * Fix units error in MultiHexagonAperture, see #485 by :user:`mperrin` in :pr:`527`
+ * replacing np.float with np.float_ per Issue 544 by :user:`adambolton` in :pr:`545`
+ * Update minimum versions across the board including remove python 3.8 and adding pythong 3.11 by :user:`BradleySappington` in :pr:`551`
+ * add option to mark levels in display_ee by :user:`douglase` in :pr:`540`
+ * minor: misc PEP8 code style consistency reformatting  by :user:`mperrin` in :pr:`554`
+ * Addition of CuPy as an Accelerated Computing Option by :user:`kian1377` in :pr:`499`
+ * remove usages of deprecated `codecov` package by :user:`zacharyburnett` in :pr:`559`
+ * Move metadata from non-standard setup.cfg into PEP 621-compliant pyproject.toml. (546 takeover) by :user:`BradleySappington` in :pr:`561`
+ * for now, skip a failing Fresnel test for the most recent scikit-image versions by :user:`mperrin` in :pr:`555`
+ * Remove older CUDA GPU code, now that it's replaced by CuPY GPU code by :user:`mperrin` in :pr:`556`
+
+**New Contributors:**
+ * :user:`evanmayer` made their first contribution in :pr:524
+ * :user:`adambolton` made their first contribution in :pr:545
+ * :user:`BradleySappington` made their first contribution in :pr:551
+ * :user:`zacharyburnett` made their first contribution in :pr:559
+
+**Full Changelog**: https://github.com/spacetelescope/poppy/compare/v1.0.3...v1.1.0
 
 
 1.0.3

diff --git a/docs/sign_conventions_for_coordinates_and_phase.ipynb b/docs/sign_conventions_for_coordinates_and_phase.ipynb
diff --git a/notebooks/Fresnel_Propagation_Demo.ipynb b/notebooks/Fresnel_Propagation_Demo.ipynb
diff --git a/notebooks/MatrixFTCoronagraph_demo.ipynb b/notebooks/MatrixFTCoronagraph_demo.ipynb
diff --git a/notebooks/POPPY Examples.ipynb b/notebooks/POPPY Examples.ipynb
diff --git a/notebooks/POPPY_tutorial.ipynb b/notebooks/POPPY_tutorial.ipynb
diff --git a/notebooks/Physical Units Demo.ipynb b/notebooks/Physical Units Demo.ipynb
diff --git a/notebooks/PowerSpectrumWFE_Demo.ipynb b/notebooks/PowerSpectrumWFE_Demo.ipynb
diff --git a/notebooks/Propagation through turbulent atmosphere.ipynb b/notebooks/Propagation through turbulent atmosphere.ipynb
diff --git a/notebooks/Shack Hartmann Wavefront Sensor Demo.ipynb b/notebooks/Shack Hartmann Wavefront Sensor Demo.ipynb
diff --git a/notebooks/Thermal Blooming Demo.ipynb b/notebooks/Thermal Blooming Demo.ipynb
diff --git a/notebooks/ThinLens_ZernikeWFE_and_ParameterizedWFE.ipynb b/notebooks/ThinLens_ZernikeWFE_and_ParameterizedWFE.ipynb