Release 1.1.0

.github/workflows/ci_workflows.yml

@@ -13,33 +13,33 @@ jobs:
 
           - name: Coverage test in Python 3
             os: ubuntu-latest
-            python: 3.9
-            toxenv: py39-poppydev-pysiafdev-cov
+            python: '3.10'
+            toxenv: py310-poppydev-pysiafdev-cov
 
           - name: Check for Sphinx doc build errors
             os: ubuntu-latest
-            python: 3.8
+            python: 3.9
             toxenv: docbuild
 
           - name: Try Astropy development version
             os: ubuntu-latest
-            python: 3.8
-            toxenv: py38-astropydev-test
+            python: 3.9
+            toxenv: py39-astropydev-test
 
           - name: Try latest versions of all dependencies
             os: ubuntu-latest
-            python: 3.9
-            toxenv: py39-latest-test
+            python: '3.10'
+            toxenv: py310-latest-test
 
           - name: Try minimum supported versions
             os: ubuntu-latest
-            python: 3.7
-            toxenv: py37-legacy37-test
+            python: 3.8
+            toxenv: py38-legacy-test
 
           - name: Try released POPPY and PySIAF
             os: ubuntu-latest
-            python: 3.7
-            toxenv: py37-stable-test
+            python: 3.8
+            toxenv: py38-stable-test
             continue-on-error: 'true'
 
     steps:
@@ -57,8 +57,8 @@ jobs:
       run: pip install tox tox-conda>=0.2
 
     - name: Get WebbPSF Data
-      run: | # Get WebbPSF data files (just a subset of the full 250 MB!) and set up environment variable
-           wget https://stsci.box.com/shared/static/ftj8esrt0apzbnff8j6m5kseii2jzy9e.gz -O /tmp/minimal-webbpsf-data.tar.gz
+      run: | # Get WebbPSF data files (just a subset of the full dataset!) and set up environment variable
+           wget https://stsci.box.com/shared/static/963l3m4hcrpc29bqxq68ilcsfgfqwiyc.gz  -O /tmp/minimal-webbpsf-data.tar.gz
            tar -xzvf /tmp/minimal-webbpsf-data.tar.gz
            echo "WEBBPSF_PATH=${{github.workspace}}/webbpsf-data" >> $GITHUB_ENV
 

.github/workflows/publish-to-pypi.yml

@@ -5,22 +5,12 @@ on:
     types: [released]
 
 jobs:
-  build:
-      name: Publish release to PyPI
-      env:
-        PYPI_USERNAME_STSCI_MAINTAINER: ${{ secrets.PYPI_USERNAME_STSCI_MAINTAINER }}
-        PYPI_PASSWORD_STSCI_MAINTAINER: ${{ secrets.PYPI_PASSWORD_STSCI_MAINTAINER }}
-        PYPI_USERNAME_OVERRIDE: ${{ secrets.PYPI_USERNAME_OVERRIDE }}
-        PYPI_PASSWORD_OVERRIDE: ${{ secrets.PYPI_PASSWORD_OVERRIDE }}
-        PYPI_TEST: ${{ secrets.PYPI_TEST }}
-        INDEX_URL_OVERRIDE: ${{ secrets.INDEX_URL_OVERRIDE }}
-      runs-on: ubuntu-latest
-      steps:
-
-          # Check out the commit containing this workflow file.
-          - name: checkout repo
-            uses: actions/checkout@v2
-
-          - name: custom action
-            uses: spacetelescope/action-publish_to_pypi@master
-            id: custom_action_0
+  publish:
+    uses: spacetelescope/action-publish_to_pypi/.github/workflows/workflow.yml@master
+    with:
+      test: false
+      build_platform_wheels: false # Set to true if your package contains a C extension
+    secrets:
+      user: ${{ secrets.PYPI_USERNAME_STSCI_MAINTAINER }}
+      password: ${{ secrets.PYPI_PASSWORD_STSCI_MAINTAINER }} # WARNING: Do not hardcode secret values here! If you want to use a different user or password, you can override this secret by creating one with the same name in your Github repository settings.
+      test_password: ${{ secrets.PYPI_PASSWORD_STSCI_MAINTAINER_TEST }}

dev_utils/field_dependence/basis.py

@@ -3,7 +3,7 @@
 import matplotlib.pyplot as plt
 import math
 
-# This is the start of an experimental protoype object oriented code for representing wavefronts.  The intent is to
+# This is the start of an experimental prototype object oriented code for representing wavefronts.  The intent is to
 # represent a wavefront in such a way that calling code doesn't need to care about the representation and can just ask
 # for the data as an array of OPD values on a regular grid, polynomial coefficients, or other without caring about
 # the internal representation or worrying about fitting or expanding polynomials out, etc.
@@ -189,7 +189,7 @@ def polynomials(self):
                 'Unit PV normalization is not implemented.  Previous implementation broke orthogonality')
             # TODO:  FIX THIS!!!  An offset like this to force things to run from -1 to 1 will break orthogonality, and
             #  must not be done.  Think about what to do instead.  Check Noll paper.  Possible just make PV truly unity
-            #  and don't care about what the absolute max and min values are.  Also impletment property decorator and
+            #  and don't care about what the absolute max and min values are.  Also implement property decorator and
             #  change decorator for changing the output normalization.
             # scale = [1]
             # offset = [0]

dev_utils/field_dependence/read_codev_dat_fits.py

@@ -7,7 +7,7 @@
 from datetime import datetime
 
 # Script that reads in a set of CodeV Pupil map OPD files across fields and instruments and fits Zernikes to the OPD
-# distribution at each field point and then Lengdres to the variation of each Zernike coefficient across field.  The
+# distribution at each field point and then Legendres to the variation of each Zernike coefficient across field.  The
 # Resulting table of Legendres coefficients for each Zernike term is written to a .fits table which is then used in
 # WebbPSF to model field dependence.
 
@@ -154,11 +154,11 @@ def main():
                                                              wavelength_nm, basis.units.nm, wf_basis=legendres)
             legendre_var_global = basis.PointByPointWavefront(cur_coeffs_global, np.ones_like(cur_coeffs_global).astype(bool), 4,
                                                              wavelength_nm, basis.units.nm, wf_basis=legendres)
-            # Pull out the Legendre coeffcients from the wavefront object
+            # Pull out the Legendre coefficients from the wavefront object
             legendre_coeffs_local[:, index] = legendre_var_local.coeffs
             legendre_coeffs_global[:, index] = legendre_var_global.coeffs
 
-            # Store the Legendre coeffcients for the current Zernike term as a fits column and store in column list.
+            # Store the Legendre coefficients for the current Zernike term as a fits column and store in column list.
             cur_fits_col_local = fits.Column(name=f'Zernike {index} Legendres', format='D', array=legendre_coeffs_local[:,index])
             fits_column_list_local.append(cur_fits_col_local)
             cur_fits_col_global = fits.Column(name=f'Zernike {index} Legendres', format='D', array=legendre_coeffs_global[:,index])

dev_utils/grab_opd_info.py

@@ -84,7 +84,7 @@ def grab_opd_info(opd_data_str, npix=1024):
         A nested dictionary containing masks (labels) for each JWST segment
     newlabels: array
         A combined label plot with segments properly combined
-    newcentorids: dictionary
+    newcentroids: dictionary
         The center of each segment in pixels(?)
     segradius: float
         The radius of each segment

dev_utils/make-minimal-datafiles.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 # Make minimal data files
-# This is used to make a stripped-down version of the data files for use on Travis CI
+# This is used to make a stripped-down version of the data files for use on GitHub Actions
 
 import os, sys
 import astropy.io.fits as fits
@@ -29,30 +29,8 @@
 os.chdir(WORKING_DIR)
 subprocess.call("tar xvzf "+inputfile, shell=True)
 
-print("#### Trimming to only one OPD file per instrument ####")
-for instr in insts:
-    files = glob.glob(os.path.join(WORKING_DIR, 'webbpsf-data', instr, "OPD", "*.fits.gz"))
-    files.sort()
-    print(instr, files)
-
-    # just save the lowest alphabetically of each of them
-    for file_to_delete in files[1:]:
-        print("Deleting "+file_to_delete)
-        os.remove(file_to_delete)
-
-    print("Trimming to only 1 datacube slice: "+files[0])
-
-    f0 = fits.open(files[0])
-    f0[0].data = f0[0].data[0]
-    f0.writeto(files[0], overwrite=True)
-    f0.close()
-
-# Do the same for the Rev AA OTE OPD
-ote_fn = os.path.join(WORKING_DIR, 'webbpsf-data','JWST_OTE_OPD_RevAA_prelaunch_predicted.fits.gz')
-f0 = fits.open(ote_fn)
-f0[0].data = f0[0].data[0]
-f0.writeto(ote_fn, overwrite=True)
-f0.close()
+# Remove this for >= 1.1.0:
+os.remove(os.path.join(WORKING_DIR, 'webbpsf-data','JWST_OTE_OPD_RevAA_prelaunch_predicted.fits.gz'))
 
 
 print("#### Removing extra optional pupil files ####")

dev_utils/wfe_benchmark.py

@@ -1,6 +1,6 @@
 # Note: meant to just copy/paste into ipython command line
 
-# Import WebbPSF and setup multliprocessing
+# Import WebbPSF and setup multiprocessing
 import webbpsf
 webbpsf.webbpsf_core.poppy.conf.use_fftw = False
 webbpsf.webbpsf_core.poppy.conf.use_multiprocessing = True

docs/_themes/theme_webbpsf/static/bootstrap-astropy.css

@@ -173,7 +173,7 @@ h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt, pre, code, tt {
   background-color: #f8f8f8;
 }
 
-/* override box for links & other sphinx-specifc stuff */
+/* override box for links & other sphinx-specific stuff */
 tt.xref, a tt, tt.descname, tt.descclassname {
   padding: 0 1px 0 1px;
   border: none;
@@ -485,7 +485,7 @@ a.headerlink {
 a.headerlink:hover {
     background-color: #0069d6;
     color: white;
-    text-docoration: none;
+    text-decoration: none;
 }
 
 

docs/_themes/theme_webbpsf/static/bootstrap-webbpsf.css

@@ -176,7 +176,7 @@ h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt, pre, code, tt {
   background-color: #f8f8f8;
 }
 
-/* override box for links & other sphinx-specifc stuff */
+/* override box for links & other sphinx-specific stuff */
 tt.xref, a tt, tt.descname, tt.descclassname {
   padding: 0 1px 0 1px;
   border: none;
@@ -488,7 +488,7 @@ a.headerlink {
 a.headerlink:hover {
     background-color: #0069d6;
     color: white;
-    text-docoration: none;
+    text-decoration: none;
 }
 
 

docs/_themes/theme_webbpsf/static/sidebar.js

@@ -5,7 +5,7 @@
  * This script makes the Sphinx sidebar collapsible.
  *
  * .sphinxsidebar contains .sphinxsidebarwrapper.  This script adds
- * in .sphixsidebar, after .sphinxsidebarwrapper, the #sidebarbutton
+ * in .sphinxsidebar, after .sphinxsidebarwrapper, the #sidebarbutton
  * used to collapse and expand the sidebar.
  *
  * When the sidebar is collapsed the .sphinxsidebarwrapper is hidden

docs/available_opds.rst

@@ -1,43 +1,35 @@
 Appendix: Available Optical Path Difference (OPD) files
 ================================================================
 
-For each of the five instruments (four SIs plus FGS) there are three provided OPD files. These represent wavefronts as follows:
-
-1. The OTE and ISIM intrinsic WFE
-2. The above, plus a slight defocus to blur the image slightly to approximate image motion.
-3. The above #2, plus additional WFE due to SI internal optics.
-
-The latter is the largest WFE, and is the default file used in simulations unless another is explicitly chosen. For NIRCam only there is a second, duplicate set of these files with slightly improved WFE based on an optimistic case scenario for instrument and telescope alignment.
-
-The provided OPDs are based on the observatory design requirements, and were developed for the Mission Critical Design Review. The represent the nominal case of performance for JWST, and have not yet been updated with as-built details of mirror surface figures, etc. We intend to make updated OPD files available once suitable reference data have been provided to STScI. For now, see `Lightsey et al. 2014 <http://adsabs.harvard.edu/abs/2014SPIE.9143E..04L>`_ for recent predictions of JWST's likely performance
-
-Note that the trick of adding some (nonphysical) defocus to blur out the PSF is computationally easy and rapid, but does not give a high fidelity
-representation of the true impact of image jitter. This is particularly true for coronagraphic observations. Future versions of WebbPSF will likely
-provide higher fidelity jitter models.
-
-The units of the supplied OPD files are wavefront error in microns.
-
-.. table:: Rev V OPDs
-
-    =========================  ==========     =======  ========================  ==========================  =======
-                         File  Instrument     RMS WFE  Includes OTE + ISIM OPD?  Image motion (as defocus)?  SI OPD?
-    =========================  ==========     =======  ========================  ==========================  =======
-        OPD_RevV_fgs_150.fits  FGS              150.0  Yes                       No                          No
-        OPD_RevV_fgs_163.fits  FGS              163.0  Yes                       Yes                         No
-        OPD_RevV_fgs_186.fits  FGS              186.0  Yes                       Yes                         Yes
-       OPD_RevV_miri_204.fits  MIRI             204.0  Yes                       No                          No
-       OPD_RevV_miri_220.fits  MIRI             220.0  Yes                       Yes                         No
-       OPD_RevV_miri_421.fits  MIRI             421.0  Yes                       Yes                         Yes
-     OPD_RevV_nircam_115.fits  NIRCam           115.0  Yes, optimistic case      No                          No
-     OPD_RevV_nircam_123.fits  NIRCam           123.0  Yes                       No                          No
-     OPD_RevV_nircam_132.fits  NIRCam           132.0  Yes, optimistic case      Yes                         No
-     OPD_RevV_nircam_136.fits  NIRCam           136.0  Yes                       Yes                         No
-     OPD_RevV_nircam_150.fits  NIRCam           150.0  Yes, optimistic case      Yes                         Yes
-     OPD_RevV_nircam_155.fits  NIRCam           155.0  Yes                       Yes                         Yes
-    OPD_RevV_nirspec_125.fits  NIRSpec          125.0  Yes                       No                          No
-    OPD_RevV_nirspec_145.fits  NIRSpec          145.0  Yes                       Yes                         No
-    OPD_RevV_nirspec_238.fits  NIRSpec          238.0  Yes                       Yes                         Yes
-     OPD_RevV_niriss_144.fits  NIRISS           144.0  Yes                       No                          No
-     OPD_RevV_niriss_162.fits  NIRISS           162.0  Yes                       Yes                         No
-     OPD_RevV_niriss_180.fits  NIRISS           180.0  Yes                       Yes                         Yes
-    =========================  ==========     =======  ========================  ==========================  =======
+
+On-Orbit OPD Measurements
+-------------------------
+
+The default OPD in WebbPSF is now an on-orbit measured OPD from early in cycle 1 science operations: 
+
+ * `JWST_OTE_OPD_cycle1_example_2022-07-30.fits`: The specific OPD measurement selected, from 2022 July 30, intentionally represents a slightly conservative alignment state (after a couple weeks of relative stability, shortly before a next wavefront correction). This is about a 75th percentile  performance level, based on operational experience during the first few months of cycle 1. Most observations will have OPDs similar to this, or slightly better; a smaller number will have not quite as good. 
+
+This intentionally-slightly-conservative OPD was chosen for use in the cycle 2 ETC and is set as the default here for consistency. 
+For modeling PSFs of science observations, it is generally best to retrieve and use the 
+`measured in-flight wavefronts <https://webbpsf.readthedocs.io/en/latest/jwst_measured_opds.html>`_ based on the date of 
+the science observation. 
+
+
+
+
+Pre-Launch Model OPDs (Obsolete)
+---------------------------------
+
+Prior versions of this page documented the _pre-flight_ models for JWST wavefronts. These models are now happily obsolete, and can be replaced by 
+`actual measured in-flight wavefronts <https://webbpsf.readthedocs.io/en/latest/jwst_measured_opds.html>`_.
+
+
+Most pre-launch predicted OPDs are no longer included in the WebbPSF data files distribution. The only such files still
+included are
+
+ * `JWST_OTE_OPD_RevAA_prelaunch_predicted.fits.gz`:  This contains predicted OPDs based on the best available optical models at the time of launch, including the calibrated, known surface figures of each mirror as measured in ground testing. For most purposes this is superceded by the on-orbit measurements. It is retained for back-compatibility mostly. 
+
+
+For any cases in which you may need further information about the other pre-launch predicted OPD files, 
+consult the `older versions of this page hosted on readthedocs<https://webbpsf.readthedocs.io/en/v0.9.0/available_opds.html>`_.
+

docs/fft_optimization.rst

@@ -170,7 +170,7 @@ Caching of plans means that irunning the same script a second time is much faste
 -----------------------------------------------------------------------------------
 Immediately after executing the above, I ran the same script again. Now the planning times all become essentially negligible.
 
-Oddly, the exection time for the largest array gets longer. I suspect this has something to do with memory or system load.  ::
+Oddly, the execution time for the largest array gets longer. I suspect this has something to do with memory or system load.  ::
 
     For arrays of size 1024x1024
     Building input circular aperture

docs/index.rst

@@ -47,6 +47,9 @@ Contents
    relnotes.rst
    usage.rst
    jwst.rst
+   jwst_optical_budgets.ipynb
+   jwst_measured_opds.ipynb
+   jwst_wavefront_deltas.ipynb
    roman.rst
    psf_grids.rst
    more_examples.rst