stips 2.2.1__tar.gz → 2.3__tar.gz

{stips-2.2.1 → stips-2.3}/CHANGES.rst

@@ -5,6 +5,23 @@ Release Notes
 Version History and Change Log
 ------------------------------
 
+Version 2.3.0
+=============
+- Added support for F213 filter.
+- Updated constants for PHOTPLAM (pivot wavelength) and mirror area.
+- Allowed users to specify `psf_cache_location` in `addCatalogue` function.
+- Transitioned detector naming convention from 'SCANN' to 'WFINN' to match other Roman SOC simulation tools.
+- Fixed bug with reading Internal tables.
+- Updated pandeia version to be >= 2024.12
+- Updated WebbPSF to STPSF and constrained version to be >= 2.0.0
+- Updated documentation to reflect that STIPS creates an intermediate product between L2 and L3 images.
+- Added documentation on (non-physical) gaps in the Phoenix grid.
+- Added citation to STIPS paper.
+
+Version 2.2.2
+=============
+- Updated pandeia.engine version to be >= 3.1 instead of == 3.1
+
 Version 2.2.1
 =============
 - Fixed a bug on the version of STIPS in __init__.py

stips-2.3/CITATION.cff

@@ -0,0 +1,41 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+- name: "STIPS Development Team"
+- family-names: "Gomez"
+  given-names: "Sebastian"
+  orcid: "https://orcid.org/0000-0001-6395-6702"
+- family-names: "Bellini"
+  given-names: "Andrea"
+  orcid: "https://orcid.org/0000-0003-3858-637X"
+- family-names: "Al-Kowsi"
+  given-names: "Hanna"
+- family-names: "Desjardins"
+  given-names: "Tyler"
+  orcid: "https://orcid.org/0000-0001-6905-1859"
+- family-names: "Geda"
+  given-names: "Robel"
+  orcid: "https://orcid.org/0000-0003-1509-9966"
+- family-names: "Han"
+  given-names: "Eunkyu"
+  orcid: "https://orcid.org/0000-0001-9797-0019"
+- family-names: "Otor"
+  given-names: "O. Justin"
+  orcid: "https://orcid.org/0000-0002-4679-5692"
+- family-names: "Riedel"
+  given-names: "Adric"
+  orcid: "https://orcid.org/0000-0003-1645-8596"
+- family-names: "Ryan"
+  given-names: "Russell"
+  orcid: "https://orcid.org/0000-0003-0894-1588"
+- family-names: "Spitzer"
+  given-names: "Isaac"
+- family-names: "York"
+  given-names: "Brian"
+title: "STIPS"
+version: 2.3.0
+doi: https://doi.org/10.5281/zenodo.15232587
+date-released: 2025-06-27
+url: "https://github.com/spacetelescope/STScI-STIPS"
+
+# see a full list of contributors here: https://github.com/spacetelescope/STScI-STIPS/graphs/contributors

{stips-2.2.1/stips.egg-info → stips-2.3}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: stips
-Version: 2.2.1
+Version: 2.3
 Summary: STIPS is the Space Telescope Imaging Product Simulator.
 Home-page: https://github.com/spacetelescope/STScI-STIPS
 Author: Space Telescope Science Institute
@@ -12,8 +12,8 @@ Requires-Dist: scipy
 Requires-Dist: photutils
 Requires-Dist: synphot>=1.1.1
 Requires-Dist: stsynphot>=1.1.0
-Requires-Dist: webbpsf>=1.1.1
-Requires-Dist: pandeia.engine==3.1
+Requires-Dist: stpsf>=2.0.0
+Requires-Dist: pandeia.engine>=2024.12
 Requires-Dist: montage-wrapper
 Requires-Dist: pyyaml
 Requires-Dist: soc_roman_tools

{stips-2.2.1 → stips-2.3}/README.md

@@ -2,6 +2,7 @@
 
 [![Build Status](https://github.com/spacetelescope/STScI-STIPS/actions/workflows/ci_workflows.yml/badge.svg?branch=main)](https://github.com/spacetelescope/STScI-STIPS/actions/workflows/ci_workflows.yml?query=branch:main)
 [![STScI](https://img.shields.io/badge/powered%20by-STScI-blue.svg?colorA=707170&colorB=3e8ddd&style=flat)](http://www.stsci.edu)
+[![DOI](https://zenodo.org/badge/94350619.svg)](https://zenodo.org/badge/latestdoi/94350619)
 
 For documentation and installation instructions please visit https://stips.readthedocs.io
 
@@ -21,8 +22,10 @@ It does not include instrument saturation effects.
 
 ## Why use STIPS?
 
-STIPS is intended to produce quick simulations of Level 2 (L2) images, and is provided for
-cases where [Pandeia](https://pypi.org/project/pandeia.engine) does not
+STIPS is intended to produce quick simulations that are corrected for distortion, but not mosaicked.
+We note there is no equivalent flight product, since Roman Level 3 (L3) files are both distortion
+corrected and mosaicked, while Level 2 (L2) files are neither. STIPS is ideal for
+cases where `Pandeia <https://pypi.org/project/pandeia.engine/>`_ does not
 provide a large enough simulation area (e.g., full-detector or multiple-detector
 observations). STIPS obtains its Roman instrument and filter values from
 Pandeia, so it should produce output within 10% of output produced by Pandeia.
@@ -43,3 +46,27 @@ developed by Andrea Bellini ([@AndreaBellini](https://github.com/AndreaBellini))
 
 ![Alt text](docs/roman_figures/stips_demo.png?raw=true "Roman WFI Image of a Star Cluster and Background Galaxies")
 
+## Citation
+
+If you use STIPS, please cite the [STIPS PASP Paper](https://ui.adsabs.harvard.edu/abs/2024PASP..136l4502S/abstract) that describes the code.
+
+```
+@ARTICLE{2024PASP..136l4502S,
+       author = {{Stips Development Team} and {Gomez}, Sebastian and {Bellini}, Andrea and {Al-Kowsi}, Hanna and {Desjardins}, Tyler and {Geda}, Robel and {Han}, Eunkyu and {Otor}, O. Justin and {Riedel}, Adric and {Ryan}, Russell and {Spitzer}, Isaac and {York}, Brian},
+        title = "{STIPS: The Nancy Grace Roman Space Telescope Imaging Product Simulator}",
+      journal = {\pasp},
+     keywords = {Astronomical techniques, Telescopes, Astronomical methods, 1684, 1689, 1043, Astrophysics - Instrumentation and Methods for Astrophysics},
+         year = 2024,
+        month = dec,
+       volume = {136},
+       number = {12},
+          eid = {124502},
+        pages = {124502},
+          doi = {10.1088/1538-3873/ad9524},
+archivePrefix = {arXiv},
+       eprint = {2411.11978},
+ primaryClass = {astro-ph.IM},
+       adsurl = {https://ui.adsabs.harvard.edu/abs/2024PASP..136l4502S},
+      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
+}
+```

{stips-2.2.1 → stips-2.3}/docs/basic_tutorial.rst

@@ -29,7 +29,7 @@ an output set of the following form:
 
     Pandeia version a.b.c with Data Version a.b.c. at /Some/Path/To/pandeia_refdata
 
-    Webbpsf Version d.e.f with Data Version d.e.f at /Some/Path/To/webbpsf_data_path
+    STPSF Version d.e.f with Data Version d.e.f at /Some/Path/To/stpsf_data_path
 
 
 Setting Up Some Basics

{stips-2.2.1 → stips-2.3}/docs/index.rst

@@ -16,7 +16,9 @@ It does not include instrument saturation effects.
 
 Why use STIPS?
 --------------
-STIPS is intended to produce quick simulations of Level 2 (L2) images, and is provided for
+STIPS is intended to produce quick simulations that are corrected for distortion, but not mosaicked.
+We note there is no equivalent flight product, since Roman Level 3 (L3) files are both distortion
+corrected and mosaicked, while Level 2 (L2) files are neither. STIPS is ideal for
 cases where `Pandeia <https://pypi.org/project/pandeia.engine/>`_ does not
 provide a large enough simulation area (e.g., full-detector or multiple-detector
 observations). STIPS obtains its Roman instrument and filter values from

{stips-2.2.1 → stips-2.3}/docs/installation.rst

@@ -9,10 +9,10 @@ in this section along with instructions.
 STIPS Requirements
 ##################
 
-* ``pandeia>=3.1``: Exposure time calculator.
+* ``pandeia>=2024.12``: Exposure time calculator.
 
-* ``webbpsf>=1.1.1``: Nancy Grace Roman PSF calculator. STIPS also requires that ``poppy``, a
-  support package used by WebbPSF, have version ``>=1.0.3``.
+* ``stpsf>=2.0.0``: Nancy Grace Roman PSF calculator. STIPS also requires that ``poppy``, a
+  support package used by STPSF (Formerly WebbPSF), have version ``>=1.0.3``.
 
 * ``astropy``: STIPS uses Astropy in order to:
 
@@ -97,7 +97,7 @@ Installing as a Developer
 Downloading Required Reference Data
 ************************************
 
-STIPS, Pandeia, and WebbPSF need the reference datasets.
+STIPS, Pandeia, and STPSF require additional reference datasets.
 You will need to download the data and add them to your environmental path.
 
 1. Add the following paths to your bash environmental path. It is recommended that you add the path to your ``.bash_profile`` file:
@@ -105,7 +105,7 @@ You will need to download the data and add them to your environmental path.
 .. code-block:: text
 
 	export stips_data="<absolute_path_to_this_folder>/ref_data/stips_data"
-	export WEBBPSF_PATH="<absolute_path_to_this_folder>/ref_data/webbpsf-data"
+	export STPSF_PATH="<absolute_path_to_this_folder>/ref_data/stpsf-data"
 	export PYSYN_CDBS="<absolute_path_to_this_folder>/ref_data/grp/redcat/trds"
 	export pandeia_refdata="<absolute_path_to_this_folder>/ref_data/pandeia_data-x.x.x_roman"
 
@@ -119,6 +119,13 @@ You will need to download the data and add them to your environmental path.
 
 		python retrieve_stips_data.py
 
+.. caution::
+
+  Running ``retrieve_stips_data.py`` will fetch the latest versions of each
+  package's reference data. If you have manually configured your software
+  environment to use other versions of any of these packages, download their
+  reference data separately and configure your environment variables
+  appropriately to avoid confusion.
 
 Testing Installation
 *********************
@@ -144,7 +151,7 @@ You should receive an output of the following form:
 
   Pandeia version a.b.c with Data Version a.b.c. at /Some/Path/To/pandeia_refdata
 
-  Webbpsf Version d.e.f with Data Version d.e.f at /Some/Path/To/webbpsf_data_path
+  STPSF Version d.e.f with Data Version d.e.f at /Some/Path/To/stpsf_data_path
 
 
 Ignore the following warning message if it appears:

{stips-2.2.1 → stips-2.3}/docs/release.rst

@@ -2,9 +2,41 @@
 Developer Release Instructions
 ******************************
 
-This page offers a complete walkthrough on how to prepare and release a new
-version of STIPS on GitHub and PyPI, as well as how to sync the ReadTheDocs
-documentation with the new release.
+This page offers a complete walkthrough on how to update the STIPS reference
+data, prepare and release a new version of STIPS on GitHub and PyPI, and sync
+the ReadTheDocs documentation with the new release.
+
+Reference data
+==============
+
+**Not every release will require an update to the reference data.** If one is
+necessary, begin by incrementing the version number in ``VERSION.txt`` at the
+base of the reference data directory.
+
+Next, regenerate the Phoenix grid by running ``stips/data/CreatePhoenixGrid.py``
+from the STIPS GitHub repository. (The file may run for an extended period.)
+Save the results to the reference data directory's ``grid/`` folder. There
+should be a ``.npy`` file for each WFI imaging filter, a coordinates file
+(``input.pkl``), and a grid-specific version file.
+
+Copy existing files from the ``test/`` folder and, if necessary, add any that
+are needed to run new tests added to the GitHub codebase during the development
+cycle. The ``.db`` files and ``residual_files`` folder at the base of the
+reference data directory can be copied as they are.
+
+Add notes on any oddities or adjustments to the reference data in ``NOTES.txt``
+at the base of the reference data directory. Finally, use the following command
+to compress the files while making sure that they will have the name STIPS
+expects (``stips_data``) when they are unzipped. Don't accidentally delete the carat (^):
+
+.. code-block:: text
+
+    tar -czvf stips_data-X.Y.Z.tgz -s /^YOUR-DIR-NAME/stips_data/ YOUR-DIR-NAME
+
+Upload the zipped reference data file to Box with the name
+``stips_data-X.Y.Z.tgz``, substituting in the version numbers selected in the
+first paragraph. **Wait to update** ``stips_data_current.tgz`` until you've
+completed the software release on GitHub.
 
 Pre-merge instructions
 ======================
@@ -24,6 +56,8 @@ intended for a release:
     * ``environment.yml``
     * ``environment_dev.yml``
     * ``docs/installation.rst``
+    * ``ref_data/retrieve_stips_data.py``
+    * ``utilities/utilities.py`` (if any reference data links have changed)
 
 * Are you able to install the new version of STIPS locally with ``pip`` and ``conda``?
 
@@ -31,6 +65,8 @@ intended for a release:
 
 * Has ``CHANGES.rst`` been updated to include the current release and its associated updates at the top?
 
+* Has ``CITATION.cff`` been updated with the relevant values in its ``version`` and ``date-released`` fields?
+
 * Are all CI tests in the release's pull request passing?
 
 * Has at least one developer given the pull request an official approval on GitHub?
@@ -44,6 +80,17 @@ Post-merge instructions
 Tagging the merge commit
 ------------------------
 
+On your machine, check out the branch that tracks the official ``main`` branch
+on the ``spacetelescope`` remote. Rebase it so it includes the newly merged pull
+request. (If your local names for that branch or the ``spacetelescope`` remote
+are different than the defaults – ``main`` and ``origin``, respectively – be
+sure to substitute them in below.)
+
+.. code-block:: text
+
+    git checkout origin main
+    git rebase origin/main
+
 Apply a tag to the merge commit, substituting in the proper version number.
 
 .. code-block:: text
@@ -57,9 +104,7 @@ Apply a tag to the merge commit, substituting in the proper version number.
    and `adding it to your account <https://docs.github.com/en/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account>`_
    if you don't have one.
 
-Next, push the tag online. (If your remote that points to ``spacetelescope``'s
-online version of the repository is not named ``origin``, be sure to substitute
-its name in below.)
+Push the tag online.
 
 .. code-block:: text
 
@@ -75,7 +120,7 @@ manually create a new release in the ``spacetelescope/STScI-STIPS`` GitHub repos
 #. Press the "Draft a new release" button above the list of releases.
 #. Press "Choose a tag" and select the one you just pushed online. The target branch should already be selected as ``main``.
 #. Press "Generate release notes" to list the commits included in this release.
-#. In the "Release title" textbox, type ``Release X.Y.Z``, substituting in the proper version number.
+#. In the "Release title" textbox, type ``STIPS Version X.Y.Z``, substituting in the proper version number.
 #. Above the list of commits in the larger textbox for comments, write a single-sentence summary of the release's major updates.
 #. Press "Publish" to complete this section.
 
@@ -130,12 +175,18 @@ Finally, upload them to PyPI:
 
 .. code-block:: text
 
-    python setup.py sdist bdist_wheel
+    python -m twine upload dist/*
 
 Note that PyPI uploads now require an API token.
 `Refer to their instructions <https://pypi.org/help/#apitoken>`_ if you haven't
 yet set one up.
 
+
+.. note::
+
+  If you updated the reference data, now is the proper time to update
+  ``stips_data_current.tgz`` on Box.
+
 While the official release is now complete, keep reading for instructions on
 updating the documentation on ReadTheDocs.
 
@@ -151,8 +202,14 @@ commit will be the repository's current latest commit, so both versions should
 be identical for the moment.
 
 The versions of the documentation that should be visible to the public and
-marked as "Active" on their "Edit" pages are ``latest`` and the new release,
-``vX.Y.Z``. In the future, we may make past versions visible, too.
+marked as "Active" on their "Edit" pages are ``main``, ``latest``, and the new
+release, ``vX.Y.Z``. On `the "Versions" page <https://readthedocs.org/projects/stips/versions/>`_,
+press "Edit" beside any other publicly visible versions and select the "Hidden"
+checkbox for them. In the future, we may make past versions visible, too.
+
+Finally, go to the "Admin" tab, make sure you're in the "Settings" section, and
+change the "Default branch" to the new ``vX.Y.Z``. (Note that this is different
+from the "Default version" setting further down the page, which should be ``latest``.)
 
 Troubleshooting: webhooks
 -------------------------

{stips-2.2.1 → stips-2.3}/docs/using_stips/catalogue_formats.rst

@@ -238,7 +238,7 @@ but is limited to a single filter. It must contain the following columns:
   retained in the observed catalog produced during the observation.)
 
 In order to identify the catalog as an Internal catalog, and in order to use
-it for STIPS observations, the following columns must be present:
+it for STIPS observations, the following metadata must be present:
 
 * ``type=internal``
 

{stips-2.2.1 → stips-2.3}/docs/using_stips/config_file.rst

@@ -116,12 +116,12 @@ PSF Convolution Configuration
 
 psf_grid_default_size (default *1*)
 	What size PSF grid should be created. Note that this value is expressed as
-	a side length, so if psf_grid_default_size is set to n, WebbPSF will create
+	a side length, so if psf_grid_default_size is set to n, STPSF will create
 	a total of n^2 PSF images. If used as a keyword argument, ``psf_grid_size``
 	can be used instead of ``psf_grid_default_size`` for historical reasons.
 
 psf_cache_enable (default *true*)
-	Whether PSF grids created by webbpsf should be cached after creation for
+	Whether PSF grids created by STPSF should be cached after creation for
 	potential re-use.
 
 psf_cache_location (default *$DATA*)

stips-2.3/docs/using_stips/phoenix_grid.rst

@@ -0,0 +1,76 @@
+Phoenix Model Grid and Gaps
+===========================
+
+Grids for the pre-computed Phoenix models are available for each Roman filter. These grids will be used when the input table type is set to :ref:`'type=phoenix' <phoenix-tables>` for point sources. The grids cover stellar parameters for a range of effective temperature (teff), surface gravity (logg), and metallicity (Z).
+
+* Effective temperature spans from 2,000 K to 70,000 K:
+
+    * at 100 K increment from 2,000 K to 7,000 K
+
+    * at 200 K increment from 7,000 K to 12,000 K
+
+    * at 500 K increment from 12,000 K to 20,000 K
+
+    * at 1000 K increment from 20,000 K to 70,000 K
+
+* Surface gravity spans from 0.0 to 5.5 at 0.5 increment
+
+* Metallicity spans from -4.0 to 0.5 dex
+
+    * at 0.5 dex increment from -4.0 to 0.0 dex
+
+    * above 0.0 dex, two points are available at 0.3 dex and 0.5 dex
+
+Gaps exist where the Phoenix models are not available due to the combination of grid points being non-physical. These are the locations of the gaps:
+
+*   At logg 0.0:
+
+    * With teff above 3,000 K and Z from -4.0 dex to -2.0 dex
+
+    * With teff above 12,500 K and Z from -1.5 dex to 0.5 dex and
+
+*   At logg 0.5:
+
+    * With teff above 3,000 K and Z from -4.0 dex to -2.0 dex
+
+    * With teff above 15,500 K and Z from -1.5 dex to 0.5 dex
+
+*   At logg 1.0:
+
+    * With teff above 21,000K and all Z
+
+*   At logg 1.5:
+
+    * With teff above 26,000K and all Z
+
+*   At logg 2.0:
+
+    * With teff above 31,000K and all Z
+
+*   At logg 2.5:
+
+    * With teff above 41,000 K and Z between -4.0 dex to -0.5 dex, at 0.3 dex, or at 0.5 dex
+
+    * With teff at 41,000 K, 43,000 K, 45,000 K, 47,000 K, 49,000 K, or above 51,000 K and Z at 0.0 dex
+
+*   At logg 3.0:
+
+    * With teff above 41,000 K and all Z
+
+*   At logg 3.5:
+
+    * With teff above 51,000 K and all Z
+
+*   At logg 5.0:
+
+    * With teff above 10,200 K and Z between -4.0 dex to -1.5 dex
+
+    * With teff above 10,000 K and Z between -1.0 dex to 0.3 dex
+
+    * With teff above 3,000 K and Z at 0.5 dex
+
+*   At logg 5.5:
+
+    * With Teff above 5,100 K and Z between -4.0 dex to 0.3 dex
+
+    * With Teff above 3,000 K and Z at 0.5 dex

{stips-2.2.1 → stips-2.3}/docs/using_stips/psf_grid.rst

@@ -4,7 +4,7 @@ The STIPS PSF Grid
 Overview
 --------
 
-As of version 2.0.0, STIPS uses WebbPSF PSF grids to implement an ePSF. The ePSF
+As of version 2.0.0, STIPS uses STPSF PSF grids to implement an ePSF. The ePSF
 uses a 3x3 grid of PSFs to handle PSF variation across the detector, and an oversample of
 4x4 to handle sub-pixel positioning. Each point source has its PSF calculated individually
 as it is added to the detector.

{stips-2.2.1 → stips-2.3}/docs/using_stips.rst

@@ -9,3 +9,4 @@ This section describes several important characteristics of STIPS.
   using_stips/catalogue_formats
   using_stips/config_file
   using_stips/psf_grid
+  using_stips/phoenix_grid

{stips-2.2.1 → stips-2.3}/environment.yml

@@ -20,7 +20,6 @@ name: stips
 channels:
   - conda-forge
   - astropy
-  - defaults
 
 dependencies:
   # Base dependencies
@@ -35,8 +34,8 @@ dependencies:
     - poppy==1.0.3
 
     # Core Modules
-    - webbpsf>=1.1.1
-    - pandeia.engine==3.1
+    - stpsf>=2.0.0
+    - pandeia.engine>=2024.12
     - synphot>=1.1.1
     - stsynphot>=1.1.0
     - soc_roman_tools

{stips-2.2.1 → stips-2.3}/environment_dev.yml

@@ -23,7 +23,6 @@ name: stips_dev
 channels:
   - conda-forge
   - astropy
-  - defaults
 
 dependencies:
   # Base dependencies
@@ -38,14 +37,14 @@ dependencies:
     # Special Modules. These are temporary entries and require documentation.
     #
     # poppy 1.0.3 fixes a bug with the way poppy was calling factorial with non-integer
-    # values. Currently this is the only way to ensure that webbpsf picks up the correct
-    # poppy version. This peg should be removed as soon as webbpsf has updated to only
+    # values. Currently this is the only way to ensure that stpsf picks up the correct
+    # poppy version. This peg should be removed as soon as stpsf has updated to only
     # use poppy versions that include this fix.
     - poppy==1.0.3
 
     # Core Modules
-    - webbpsf>=1.1.1
-    - pandeia.engine==3.1
+    - stpsf>=2.0.0
+    - pandeia.engine>=2024.12
     - synphot>=1.1.1
     - stsynphot>=1.1.0
     - soc_roman_tools

{stips-2.2.1 → stips-2.3}/notebooks/STIPS Advanced II - PSFs.ipynb

@@ -66,7 +66,7 @@
    "source": [
     "## Generating and Manipulating a PSF\n",
     "\n",
-    "PSFs can be generated using FITS input files and the makePSF module within STIPS.  For this example, we will be using the example PSF file \"psf_WFI_2.0.0_F129_sca01.fits\", a PSF generated with Roman WFI F129.  This file is available in the \"notebooks\" directory of STIPS.  The generated PSF will be returned as an array."
+    "PSFs can be generated using FITS input files and the makePSF module within STIPS.  For this example, we will be using the example PSF file \"psf_WFI_2.0.0_F129_wfi01.fits\", a PSF generated with Roman WFI F129.  This file is available in the \"notebooks\" directory of STIPS.  The generated PSF will be returned as an array."
    ]
   },
   {
@@ -76,7 +76,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "example_file = fits.open('notebooks_data/psf_WFI_2.0.0_F129_sca01.fits')\n",
+    "example_file = fits.open('notebooks_data/psf_WFI_2.0.0_F129_wfi01.fits')\n",
     "\n",
     "test_psf = stips.utilities.makePSF.make_epsf(example_file[0].data[0])\n",
     "\n",

{stips-2.2.1 → stips-2.3}/ref_data/retrieve_stips_data.py

@@ -1,12 +1,12 @@
 ### Instructions ###
 # 1. In your ~/.bash_profile file, copy the following environment variables into
-#    the same file (making sure to update 1.x.x version of Pandeia you're using
-#    –– for STIPS this should be 1.7):
+#    the same file:
 #       export stips_data="<absolute_path_to_this_folder>/ref_data/stips_data"
-#       export WEBBPSF_PATH="<absolute_path_to_this_folder>/ref_data/webbpsf-data"
+#       export STPSF_PATH="<absolute_path_to_this_folder>/ref_data/stpsf-data"
 #       export PYSYN_CDBS="<absolute_path_to_this_folder>/ref_data/grp/redcat/trds"
 #       export pandeia_refdata="<absolute_path_to_this_folder>/ref_data/pandeia_data-
-#       1.7_roman"
+#       2024.12-roman"
+#
 # 2. In the ref_data folder, run the script: python retrieve_stips_data.py
 
 import stips

{stips-2.2.1 → stips-2.3}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = stips
-version = 2.2.1
+version = 2.3
 author = Space Telescope Science Institute
 author_email = york@stsci.edu
 description = STIPS is the Space Telescope Imaging Product Simulator.
@@ -22,8 +22,8 @@ install_requires =
 	photutils
 	synphot>=1.1.1
 	stsynphot>=1.1.0
-	webbpsf>=1.1.1
-	pandeia.engine==3.1
+	stpsf>=2.0.0
+	pandeia.engine>=2024.12
 	montage-wrapper
 	pyyaml
 	soc_roman_tools

{stips-2.2.1 → stips-2.3}/stips/__init__.py

@@ -4,7 +4,7 @@ import os
 
 __all__ = ['observation_module', 'scene_module']
 
-__version__ = "2.2.1"
+__version__ = "2.3"
 version = __version__
 
 from .utilities import SetupDataPaths