Merge pull request #948 from spacetelescope/develop

v1.5.0

.github/workflows/build.yml

@@ -8,7 +8,7 @@ on:
 
 jobs:
   build:
-    uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@v1
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@924441154cf3053034c6513d5e06c69d262fb9a6  # v1.13.0
     with:
       upload_to_pypi: ${{ (github.event_name == 'release') && (github.event.action == 'released') }}
     secrets:

.github/workflows/ci_workflows.yml

@@ -4,7 +4,7 @@ on: [push, pull_request]
 
 jobs:
   retrieve_cache:
-    uses: spacetelescope/webbpsf/.github/workflows/retrieve_cache.yml@develop
+    uses: spacetelescope/webbpsf/.github/workflows/retrieve_cache.yml@beda656c80a0254e6f80649d9c9c49235634522f  # v1.4.0
     with:
       minimal: true
   tests:
@@ -49,20 +49,20 @@ jobs:
 
     steps:
     - name: Checkout code
-      uses: actions/checkout@v4
+      uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938  # v4.2.0
       with:
         fetch-depth: 0
 
     - name: Set up Python ${{ matrix.python }}
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3  # v5.2.0
       with:
         python-version: ${{ matrix.python }}
 
     - name: Install Python dependencies
       run: pip install tox tox-conda>=0.2
 
     - name: Get WebbPSF Data
-      uses: actions/cache/restore@v4
+      uses: actions/cache/restore@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9  # v4.0.2
       with:
         path: ${{ needs.retrieve_cache.outputs.cache_path }}
         key: ${{ needs.retrieve_cache.outputs.cache_key }}
@@ -90,6 +90,6 @@ jobs:
 
     - name: Upload coverage to codecov
       if: ${{ contains(matrix.toxenv,'-cov') }}
-      uses: codecov/codecov-action@v2
+      uses: codecov/codecov-action@e28ff129e5465c2c0dcc6f003fc735cb6ae0c673  # v4.5.0
       with:
         file: ./coverage.xml

.github/workflows/download_data.yml

@@ -18,7 +18,7 @@
 #     - cron: "0 0 * * 0"
 # jobs:
 #   download_webbpsf:
-#     uses: spacetelescope/webbpsf/.github/workflows/download_data.yml@develop
+#     uses: spacetelescope/webbpsf/.github/workflows/download_data.yml@beda656c80a0254e6f80649d9c9c49235634522f  # v1.4.0
 #     with:
 #       minimal: true
 
@@ -27,8 +27,13 @@ name: download and cache data
 on:
   workflow_call:
     inputs:
+      url:
+        description: URL to gzip file
+        type: string
+        required: false
+        default: https://stsci.box.com/shared/static/0dt9z6b927iqgtify2a4cvls9hvapi6k.gz
       minimal:
-        description: minimal dataset
+        description: dataset is minimal (as opposed to full)
         type: boolean
         required: false
         default: true
@@ -41,25 +46,33 @@ on:
         value: ${{ jobs.download.outputs.cache_key }}
   workflow_dispatch:
     inputs:
+      url:
+        description: URL to gzip file
+        type: string
+        required: false
+        default: https://stsci.box.com/shared/static/0dt9z6b927iqgtify2a4cvls9hvapi6k.gz
       minimal:
-        description: minimal dataset
+        description: dataset is minimal (as opposed to full)
         type: boolean
         required: false
         default: true
   schedule:
     - cron: "0 0 * * 0"
   release:
+  push:
+    branches:
+      - develop
 
 env:
-  DATA_URL: https://stsci.box.com/shared/static/qxpiaxsjwo15ml6m4pkhtk36c9jgj70k.gz
+  FULL_DATA_URL: https://stsci.box.com/shared/static/qxpiaxsjwo15ml6m4pkhtk36c9jgj70k.gz
   MINIMAL_DATA_URL: https://stsci.box.com/shared/static/0dt9z6b927iqgtify2a4cvls9hvapi6k.gz
 
 jobs:
   download:
     name: download and cache WebbPSF data
     runs-on: ubuntu-latest
     steps:
-      - run: wget ${{ (github.event_name == 'schedule' || github.event_name == 'release') && env.MINIMAL_DATA_URL || inputs.minimal && env.MINIMAL_DATA_URL || env.DATA_URL }} -O ${{ runner.temp }}/webbpsf-data.tar.gz
+      - run: wget ${{ (github.event_name == 'workflow_dispatch' || github.event_name == 'workflow_call') && inputs.url || env.MINIMAL_DATA_URL }} -O ${{ runner.temp }}/webbpsf-data.tar.gz
       - run: mkdir ${{ runner.temp }}/data/
       - run: tar -xzvf ${{ runner.temp }}/webbpsf-data.tar.gz -C ${{ runner.temp }}/data/
       - id: cache_path
@@ -68,7 +81,7 @@ jobs:
         run: echo "version=$(cat ${{ steps.cache_path.outputs.cache_path }}/webbpsf-data/version.txt)" >> $GITHUB_OUTPUT
       - id: cache_key
         run: echo "cache_key=webbpsf-data-${{ (github.event_name == 'schedule' || github.event_name == 'release') && 'mini' || inputs.minimal && 'mini' || 'full' }}-${{ steps.version.outputs.version }}" >> $GITHUB_OUTPUT
-      - uses: actions/cache/save@v4
+      - uses: actions/cache/save@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9  # v4.0.2
         with:
           path: ${{ runner.temp }}/data/
           key: ${{ steps.cache_key.outputs.cache_key }}

.github/workflows/retrieve_cache.yml

@@ -13,15 +13,15 @@
 # ...
 # jobs:
 #   webbpsf_data_cache_key:
-#     uses: spacetelescope/webbpsf/.github/workflows/retrieve_cache.yml@develop
+#     uses: spacetelescope/webbpsf/.github/workflows/retrieve_cache.yml@beda656c80a0254e6f80649d9c9c49235634522f  # v1.4.0
 #     with:
 #       minimal: true
 #   tests:
 #     needs: [ webbpsf_data_cache_key ]
 #     steps:
 #       ...
 #       - name: retrieve WebbPSF data cache
-#        uses: actions/cache/restore@v4
+#        uses: actions/cache/restore@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9  # v4.0.2
 #        with:
 #          path: ${{ runner.temp }}/webbpsf-data
 #          key: ${{ needs.webbpsf_data_cache_key.outputs.cache_key }}

CITATION.cff

@@ -56,4 +56,4 @@ abstract: >-
   including its Wide Field Instrument and a preliminary
   version of the Coronagraph Instrument.
 license: BSD-3-Clause
-version: 1.4.0
+version: 1.5.0

README.rst

@@ -21,6 +21,14 @@ WebbPSF: Simulated Point Spread Functions for the James Webb and Nancy Grace Rom
 .. image:: https://img.shields.io/badge/ascl-1504.007-blue.svg?colorB=262255
    :target: http://ascl.net/1504.007
 
+
+**ADVISORY: WebbPSF IS BEING MIGRATED TO A NEW REPOSITORY: STPSF (Space Telescope PSF)**
+
+   **To reflect its broader support for Roman as well as James Webb, WebbPSF is being migrated to a new repository: STPSF (Space Telescope PSF).**
+   **This transition is being done in such a way as to maintain back-compatibility for existing code, and existing installations will continue to run as-is.**
+   **This transitional period is ongoing now. Please do not submit pull requests to this webbpsf repo at this time.**
+   **The STPSF github repository will soon be available for use instead.**
+
 WebbPSF produces simulated PSFs for the James Webb Space Telescope, NASA's
 flagship infrared space telescope. WebbPSF can simulate images for any of the
 four science instruments plus the fine guidance sensor, including both direct
@@ -29,8 +37,12 @@ imaging, coronagraphic, and spectroscopic modes.
 WebbPSF also supports simulating PSFs for the upcoming Nancy Grace Roman Space Telescope (formerly WFIRST),
 including its Wide Field Instrument and a preliminary version of the Coronagraph Instrument.
 
-Developed by Marshall Perrin, Joseph Long, Shannon Osborne, Robel Geda, Bradley Sappington, Marcio Meléndez, 
-Charles-Phillipe Lajoie, Jarron Leisenring, Neil Zimmerman, Keira Brooks, 
+.. note::
+
+   The current Roman WFI optical model was provided by Goddard Space Flight Center circa 2021 (the Cycle 9 reference data); a new optical model is currently being implemented in WebbPSF.
+
+Developed by Marshall Perrin, Joseph Long, Shannon Osborne, Robel Geda, Bradley Sappington, Marcio Meléndez,
+Charles-Philippe Lajoie, Jarron Leisenring, Neil Zimmerman, Keira Brooks,
 Justin Otor, Trey Kulp, Lauren Chambers, Alden Jurling, and collaborators, 2010-2024.
 
 Documentation can be found online at https://webbpsf.readthedocs.io

docs/index.rst

@@ -61,6 +61,7 @@ Contents
    jwst_measured_opds.ipynb
    jwst_detector_effects.ipynb
    jwst_matching_psfs_to_data.ipynb
+   jwst_ifu_datacubes.ipynb
    jwst_large_psf.ipynb
    jwst_optical_budgets.ipynb
    jwst_psf_subtraction.ipynb