stips 2.3__tar.gz → 2.3.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {stips-2.3 → stips-2.3.1}/.github/workflows/ci_workflows.yml +8 -8
- {stips-2.3 → stips-2.3.1}/.rtd-environment.yml +1 -4
- {stips-2.3 → stips-2.3.1}/CHANGES.rst +22 -10
- {stips-2.3 → stips-2.3.1}/CITATION.cff +2 -2
- {stips-2.3 → stips-2.3.1}/Dockerfile +0 -1
- {stips-2.3 → stips-2.3.1}/PKG-INFO +3 -2
- {stips-2.3 → stips-2.3.1}/docs/bugs.rst +4 -2
- {stips-2.3 → stips-2.3.1}/docs/conf.py +2 -1
- {stips-2.3 → stips-2.3.1}/docs/examples.rst +0 -1
- stips-2.3.1/docs/help.rst +9 -0
- {stips-2.3 → stips-2.3.1}/docs/installation.rst +40 -27
- {stips-2.3 → stips-2.3.1}/docs/release.rst +1 -0
- stips-2.3.1/docs/requirements.txt +8 -0
- {stips-2.3 → stips-2.3.1}/docs/using_stips/catalogue_formats.rst +3 -2
- {stips-2.3 → stips-2.3.1}/docs/using_stips/config_file.rst +12 -18
- {stips-2.3 → stips-2.3.1}/environment.yml +8 -7
- {stips-2.3 → stips-2.3.1}/environment_dev.yml +8 -13
- {stips-2.3 → stips-2.3.1}/notebooks/STIPS Advanced I /342/200/223 Further Observations, Noise and Distortion.ipynb" +1 -1
- {stips-2.3 → stips-2.3.1}/notebooks/STIPS Advanced II - PSFs.ipynb +1 -1
- {stips-2.3 → stips-2.3.1}/ref_data/retrieve_stips_data.py +3 -2
- {stips-2.3 → stips-2.3.1}/setup.cfg +4 -3
- {stips-2.3 → stips-2.3.1}/stips/__init__.py +1 -1
- {stips-2.3 → stips-2.3.1}/stips/astro_image/astro_image.py +12 -7
- {stips-2.3 → stips-2.3.1}/stips/data/stips_config.yaml +7 -5
- {stips-2.3 → stips-2.3.1}/stips/instruments/instrument.py +12 -5
- {stips-2.3 → stips-2.3.1}/stips/instruments/wfi.py +63 -8
- {stips-2.3 → stips-2.3.1}/stips/utilities/utilities.py +93 -27
- {stips-2.3 → stips-2.3.1}/stips.egg-info/PKG-INFO +3 -2
- {stips-2.3 → stips-2.3.1}/stips.egg-info/SOURCES.txt +0 -1
- {stips-2.3 → stips-2.3.1}/stips.egg-info/requires.txt +2 -1
- stips-2.3/CITATION +0 -8
- stips-2.3/docs/help.rst +0 -6
- stips-2.3/docs/requirements.txt +0 -9
- {stips-2.3 → stips-2.3.1}/.gitignore +0 -0
- {stips-2.3 → stips-2.3.1}/.readthedocs.yaml +0 -0
- {stips-2.3 → stips-2.3.1}/CODE_OF_CONDUCT.md +0 -0
- {stips-2.3 → stips-2.3.1}/CONTRIBUTING.md +0 -0
- {stips-2.3 → stips-2.3.1}/MANIFEST.in +0 -0
- {stips-2.3 → stips-2.3.1}/README.md +0 -0
- {stips-2.3 → stips-2.3.1}/docs/Makefile +0 -0
- {stips-2.3 → stips-2.3.1}/docs/basic_tutorial.rst +0 -0
- {stips-2.3 → stips-2.3.1}/docs/exts/numfig.py +0 -0
- {stips-2.3 → stips-2.3.1}/docs/index.rst +4 -4
- {stips-2.3 → stips-2.3.1}/docs/make.bat +0 -0
- {stips-2.3 → stips-2.3.1}/docs/roman_figures/stips_basic_tutorial.png +0 -0
- {stips-2.3 → stips-2.3.1}/docs/roman_figures/stips_demo.png +0 -0
- {stips-2.3 → stips-2.3.1}/docs/rtd-pip-requirements +0 -0
- {stips-2.3 → stips-2.3.1}/docs/using_stips/phoenix_grid.rst +0 -0
- {stips-2.3 → stips-2.3.1}/docs/using_stips/psf_grid.rst +0 -0
- {stips-2.3 → stips-2.3.1}/docs/using_stips.rst +0 -0
- {stips-2.3 → stips-2.3.1}/licenses/LICENSE.rst +0 -0
- {stips-2.3 → stips-2.3.1}/licenses/README.rst +0 -0
- {stips-2.3 → stips-2.3.1}/licenses/TEMPLATE_LICENCE.rst +0 -0
- {stips-2.3 → stips-2.3.1}/notebooks/STIPS Basic Tutorial.ipynb +0 -0
- {stips-2.3 → stips-2.3.1}/notebooks/notebooks_data/psf_WFI_2.0.0_F129_wfi01.fits +0 -0
- {stips-2.3 → stips-2.3.1}/setup.py +0 -0
- {stips-2.3 → stips-2.3.1}/stips/astro_image/__init__.py +0 -0
- {stips-2.3 → stips-2.3.1}/stips/astro_image/tests/__init__.py +0 -0
- {stips-2.3 → stips-2.3.1}/stips/astro_image/tests/test_AstroImage.py +0 -0
- {stips-2.3 → stips-2.3.1}/stips/astro_image/tests/test_header.py +0 -0
- {stips-2.3 → stips-2.3.1}/stips/astro_image/tests/test_wcs.py +0 -0
- {stips-2.3 → stips-2.3.1}/stips/conftest.py +0 -0
- {stips-2.3 → stips-2.3.1}/stips/data/CreateIsochroneGrid.py +0 -0
- {stips-2.3 → stips-2.3.1}/stips/data/CreatePhoenixGrid.py +0 -0
- {stips-2.3 → stips-2.3.1}/stips/data/__init__.py +0 -0
- {stips-2.3 → stips-2.3.1}/stips/data/psf_WFI_2.0.0_F129_wfi01.fits +0 -0
- {stips-2.3 → stips-2.3.1}/stips/errors/__init__.py +0 -0
- {stips-2.3 → stips-2.3.1}/stips/errors/make_cosmic_ray.py +0 -0
- {stips-2.3 → stips-2.3.1}/stips/instruments/__init__.py +0 -0
- {stips-2.3 → stips-2.3.1}/stips/instruments/roman_instrument.py +0 -0
- {stips-2.3 → stips-2.3.1}/stips/observation_module/__init__.py +0 -0
- {stips-2.3 → stips-2.3.1}/stips/observation_module/observation_module.py +0 -0
- {stips-2.3 → stips-2.3.1}/stips/scene_module/__init__.py +0 -0
- {stips-2.3 → stips-2.3.1}/stips/scene_module/convert_units.py +0 -0
- {stips-2.3 → stips-2.3.1}/stips/scene_module/scene_module.py +0 -0
- {stips-2.3 → stips-2.3.1}/stips/stellar_module/__init__.py +0 -0
- {stips-2.3 → stips-2.3.1}/stips/stellar_module/star_generator.py +0 -0
- {stips-2.3 → stips-2.3.1}/stips/tests/__init__.py +0 -0
- {stips-2.3 → stips-2.3.1}/stips/utilities/DataTable.py +0 -0
- {stips-2.3 → stips-2.3.1}/stips/utilities/__init__.py +0 -0
- {stips-2.3 → stips-2.3.1}/stips/utilities/makePSF.py +0 -0
- {stips-2.3 → stips-2.3.1}/stips/utilities/testing.py +0 -0
- {stips-2.3 → stips-2.3.1}/stips/utilities/tests/test_config.py +0 -0
- {stips-2.3 → stips-2.3.1}/stips/utilities/tests/test_makePSF.py +0 -0
- {stips-2.3 → stips-2.3.1}/stips.egg-info/dependency_links.txt +0 -0
- {stips-2.3 → stips-2.3.1}/stips.egg-info/not-zip-safe +0 -0
- {stips-2.3 → stips-2.3.1}/stips.egg-info/top_level.txt +0 -0
- {stips-2.3 → stips-2.3.1}/tox.ini +0 -0
|
@@ -14,21 +14,21 @@ jobs:
|
|
|
14
14
|
matrix:
|
|
15
15
|
include:
|
|
16
16
|
|
|
17
|
-
- name: Python 3.
|
|
17
|
+
- name: Python 3.11
|
|
18
18
|
os: ubuntu-latest
|
|
19
|
-
python: "3.
|
|
19
|
+
python: "3.11"
|
|
20
20
|
|
|
21
|
-
- name: Python 3.
|
|
21
|
+
- name: Python 3.13
|
|
22
22
|
os: ubuntu-latest
|
|
23
|
-
python: 3.
|
|
23
|
+
python: 3.13
|
|
24
24
|
|
|
25
|
-
- name: Python 3.
|
|
25
|
+
- name: Python 3.13 Mac
|
|
26
26
|
os: macos-latest
|
|
27
|
-
python: 3.
|
|
27
|
+
python: 3.13
|
|
28
28
|
|
|
29
29
|
- name: Python Long
|
|
30
30
|
os: ubuntu-latest
|
|
31
|
-
python: 3.
|
|
31
|
+
python: 3.13
|
|
32
32
|
|
|
33
33
|
steps:
|
|
34
34
|
- name: Checkout code
|
|
@@ -72,7 +72,7 @@ jobs:
|
|
|
72
72
|
with:
|
|
73
73
|
activate-environment: stips
|
|
74
74
|
environment-file: environment.yml
|
|
75
|
-
python-version: 3.
|
|
75
|
+
python-version: 3.13
|
|
76
76
|
auto-activate-base: false
|
|
77
77
|
|
|
78
78
|
- name: Build Docs
|
|
@@ -5,11 +5,24 @@ Release Notes
|
|
|
5
5
|
Version History and Change Log
|
|
6
6
|
------------------------------
|
|
7
7
|
|
|
8
|
+
Version 2.3.1
|
|
9
|
+
=============
|
|
10
|
+
- Fixed a bug with unit conversion for Pandeia backgrounds
|
|
11
|
+
- Fixed a bug that prevented use of cached PSFs with STPSF v2.0.0, slowing ``fast_galaxy`` simulations
|
|
12
|
+
- Added FITS header outputs for original input X and Y positions alongside those for the PSF interpolation
|
|
13
|
+
- Implemented dynamic calculation of zeropoints based on WFI throughput files from the user's local Pandeia reference data
|
|
14
|
+
- Imposed and documented photon and electron unit equivalence since STIPS assumes a quantum efficiency of 1
|
|
15
|
+
- Added documentation about the now uneditable 3x3 ``psf_grid_size``
|
|
16
|
+
- Added documentation about installing STIPS with alternate package managers
|
|
17
|
+
- Updated pandeia version to be >= 2025.9 and utilities infrastructure to handle new reference data in 2026.1
|
|
18
|
+
- Allowed newer versions of poppy >= 1.0.3
|
|
19
|
+
- Updated contact information for Roman Help Desk
|
|
20
|
+
|
|
8
21
|
Version 2.3.0
|
|
9
22
|
=============
|
|
10
23
|
- Added support for F213 filter.
|
|
11
24
|
- Updated constants for PHOTPLAM (pivot wavelength) and mirror area.
|
|
12
|
-
- Allowed users to specify
|
|
25
|
+
- Allowed users to specify ``psf_cache_location`` in ``addCatalogue`` function.
|
|
13
26
|
- Transitioned detector naming convention from 'SCANN' to 'WFINN' to match other Roman SOC simulation tools.
|
|
14
27
|
- Fixed bug with reading Internal tables.
|
|
15
28
|
- Updated pandeia version to be >= 2024.12
|
|
@@ -24,7 +37,7 @@ Version 2.2.2
|
|
|
24
37
|
|
|
25
38
|
Version 2.2.1
|
|
26
39
|
=============
|
|
27
|
-
- Fixed a bug on the version of STIPS in __init__.py
|
|
40
|
+
- Fixed a bug on the version of STIPS in ``__init__.py``
|
|
28
41
|
- Updated WebbPSF version to be >= 1.1.1 instead of == 1.1.1
|
|
29
42
|
- Updated synphot>=1.1.1 and stsynphot>=1.1.0 from forced to specific version.
|
|
30
43
|
|
|
@@ -45,7 +58,6 @@ Version 2.1.0
|
|
|
45
58
|
|
|
46
59
|
Version 2.0.0
|
|
47
60
|
=============
|
|
48
|
-
|
|
49
61
|
- STIPS now uses an ePSF, and calculates source appearance on a per-source basis
|
|
50
62
|
- Dropped support for python 2, and python <= 3.7
|
|
51
63
|
- Dropped support for HST and JWST instruments
|
|
@@ -61,13 +73,13 @@ Version 1.0.8
|
|
|
61
73
|
|
|
62
74
|
**STIPS Improvements**
|
|
63
75
|
|
|
64
|
-
- PSFs generated with
|
|
65
|
-
- STIPS has the option to keep all data in memory. [:pr
|
|
76
|
+
- PSFs generated with ``webbpsf`` are now PSF grids. [:pr:`77`, :user:`york-stsci`]
|
|
77
|
+
- STIPS has the option to keep all data in memory. [:pr:`77`, :user:`york-stsci`]
|
|
66
78
|
- Data files have been removed from the repo to allow STIPS to be uploaded to PyPi (pip). The data has been migrated to a STScI box folder. Users can now download the data and set their `stips_data` to allow access to the data that once lived in the repository. [:pr:`59`, :user:`york-stsci`]
|
|
67
79
|
- Travis was setup to run and pass tests. Outdated tests have been removed to allow Travis to pass. [:pr:`65`, :user:`robelgeda`]
|
|
68
80
|
- Test data has been moved to a STScI box folder. [:pr:`64`, :user:`robelgeda`]
|
|
69
|
-
-
|
|
70
|
-
- Frozen environments saved at
|
|
81
|
+
- ``dev`` folder added for any developer related tools. [:pr:`69`, :user:`robelgeda`]
|
|
82
|
+
- Frozen environments saved at ``dev/conda_envs``. [:pr:`69`, :user:`robelgeda`]
|
|
71
83
|
|
|
72
84
|
Version 1.0.7
|
|
73
85
|
=============
|
|
@@ -80,7 +92,7 @@ Version 1.0.7
|
|
|
80
92
|
- environment.yml added for easy conda env build. [:pr:`42`, :user:`robelgeda`]
|
|
81
93
|
- Read the Docs documentation established. [:pr:`55`, :user:`robelgeda`]
|
|
82
94
|
- F062 filter added to Roman WFI. [:pr:`51`, :user:`york-stsci`]
|
|
83
|
-
- Update STIPS to use
|
|
95
|
+
- Update STIPS to use WebbPSF 0.9.0. [:pr:`51`, :user:`york-stsci`]
|
|
84
96
|
- Travis CI initiated for unit and regression testing. [:pr:`40`, :user:`robelgeda`]
|
|
85
97
|
- Python version set to 3.7 [:pr:`40`, :user:`robelgeda`]
|
|
86
98
|
- Licenses updated [:pr:`40`, :user:`robelgeda`]
|
|
@@ -89,8 +101,8 @@ Version 1.0.7
|
|
|
89
101
|
|
|
90
102
|
- Updated astro_image.py to use a PC matrix rather than a CD matrix for the image WCS, which hopefully will result in astropy actually giving you a correctly formatted FITS WCS. [:pr:`46`, :user:`york-stsci`]
|
|
91
103
|
- Adding WCS information to PSF files. PSF files will now have the following:
|
|
104
|
+
|
|
92
105
|
- RA equal to the observation RA at which they were produced
|
|
93
106
|
- DEC equal to the observation DEC at which they were produced
|
|
94
107
|
- PA equal to the observation PA at which they were produced
|
|
95
|
-
- CDELT keywords equal to the PIXELSCL keyword, but adjusted to degrees rather than arcsec.
|
|
96
|
-
- [:pr:`47`, :user:`york-stsci`]
|
|
108
|
+
- CDELT keywords equal to the PIXELSCL keyword, but adjusted to degrees rather than arcsec. [:pr:`47`, :user:`york-stsci`]
|
|
@@ -33,9 +33,9 @@ authors:
|
|
|
33
33
|
- family-names: "York"
|
|
34
34
|
given-names: "Brian"
|
|
35
35
|
title: "STIPS"
|
|
36
|
-
version: 2.3.
|
|
36
|
+
version: 2.3.1
|
|
37
37
|
doi: https://doi.org/10.5281/zenodo.15232587
|
|
38
|
-
date-released:
|
|
38
|
+
date-released: 2026-05-08
|
|
39
39
|
url: "https://github.com/spacetelescope/STScI-STIPS"
|
|
40
40
|
|
|
41
41
|
# see a full list of contributors here: https://github.com/spacetelescope/STScI-STIPS/graphs/contributors
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: stips
|
|
3
|
-
Version: 2.3
|
|
3
|
+
Version: 2.3.1
|
|
4
4
|
Summary: STIPS is the Space Telescope Imaging Product Simulator.
|
|
5
5
|
Home-page: https://github.com/spacetelescope/STScI-STIPS
|
|
6
6
|
Author: Space Telescope Science Institute
|
|
@@ -13,7 +13,8 @@ Requires-Dist: photutils
|
|
|
13
13
|
Requires-Dist: synphot>=1.1.1
|
|
14
14
|
Requires-Dist: stsynphot>=1.1.0
|
|
15
15
|
Requires-Dist: stpsf>=2.0.0
|
|
16
|
-
Requires-Dist:
|
|
16
|
+
Requires-Dist: poppy>=1.0.3
|
|
17
|
+
Requires-Dist: pandeia.engine>=2025.9
|
|
17
18
|
Requires-Dist: montage-wrapper
|
|
18
19
|
Requires-Dist: pyyaml
|
|
19
20
|
Requires-Dist: soc_roman_tools
|
|
@@ -14,9 +14,11 @@ removed from this list as they are addressed in future STIPS updates.
|
|
|
14
14
|
* The flux measurements of sources are only validated in the absence of noise/background.
|
|
15
15
|
As such, the net flux of the image may be inaccurate.
|
|
16
16
|
|
|
17
|
-
* STIPS interpolates nine PSFs generated by
|
|
17
|
+
* STIPS interpolates nine PSFs generated by STPSF across the detector to the location of the
|
|
18
18
|
source being placed. However, there is currently a known offset of 20 pixels (in both the
|
|
19
19
|
X and Y directions) between the location at which the PSF is interpolated, and the
|
|
20
|
+
location at which the target is displayed. The header of the output image lists both of these locations:
|
|
21
|
+
'x' and 'y' for the location at which the PSF is interpolated and 'x_input' and 'y_input' for the
|
|
20
22
|
location at which the target is displayed.
|
|
21
23
|
|
|
22
24
|
.. note::
|
|
@@ -26,7 +28,7 @@ removed from this list as they are addressed in future STIPS updates.
|
|
|
26
28
|
(x, y) but the interpolated PSF shape will be the shape of the PSF at location (x+20, y+20).
|
|
27
29
|
Because the WFI PSF shape does not vary strongly over this distance, the effect is
|
|
28
30
|
minimal and should not be a concern for most science cases. If ultra-precise PSF models
|
|
29
|
-
are required, the user should generate them directly with
|
|
31
|
+
are required, the user should generate them directly with STPSF at the desired pixel
|
|
30
32
|
location.
|
|
31
33
|
|
|
32
34
|
* Bright sources will have large diffraction spikes that are visible beyond 22 pixels away
|
|
@@ -67,6 +67,7 @@ extensions = [
|
|
|
67
67
|
'sphinx.ext.mathjax',
|
|
68
68
|
'sphinx.ext.viewcode',
|
|
69
69
|
'sphinx_rtd_theme',
|
|
70
|
+
'sphinx_issues'
|
|
70
71
|
]
|
|
71
72
|
|
|
72
73
|
numpydoc_show_class_members = False
|
|
@@ -186,4 +187,4 @@ if eval(setup_cfg.get('edit_on_github')):
|
|
|
186
187
|
edit_on_github_doc_root = "docs"
|
|
187
188
|
|
|
188
189
|
# -- Resolving issue number to links in changelog -----------------------------
|
|
189
|
-
|
|
190
|
+
issues_default_group_project = setup_cfg['github_project'] # for sphinx_issues
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
****
|
|
2
|
+
Help
|
|
3
|
+
****
|
|
4
|
+
|
|
5
|
+
For assistance with STIPS, please visit the
|
|
6
|
+
`Roman Help Desk <https://stsci.service-now.com/roman>`_. After logging in to
|
|
7
|
+
your account, select "Get Help" and then the "Simulators and Tools" category.
|
|
8
|
+
Mention STIPS in the subject line and include relevant details in the
|
|
9
|
+
description of the resulting form.
|
|
@@ -9,18 +9,14 @@ in this section along with instructions.
|
|
|
9
9
|
STIPS Requirements
|
|
10
10
|
##################
|
|
11
11
|
|
|
12
|
-
* ``pandeia>=
|
|
12
|
+
* ``pandeia>=2025.9``: Exposure time calculator.
|
|
13
13
|
|
|
14
14
|
* ``stpsf>=2.0.0``: Nancy Grace Roman PSF calculator. STIPS also requires that ``poppy``, a
|
|
15
15
|
support package used by STPSF (Formerly WebbPSF), have version ``>=1.0.3``.
|
|
16
16
|
|
|
17
|
-
* ``astropy``: STIPS uses Astropy in order to
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
* Read and write ASCII tables (specifically in the IPAC format).
|
|
22
|
-
|
|
23
|
-
* Generate Sersic profile models (if any are in the generated scene).
|
|
17
|
+
* ``astropy``: STIPS uses Astropy in order to read and write ASCII tables
|
|
18
|
+
(specifically in the IPAC format) and FITS files, as well as to generate
|
|
19
|
+
Sersic profile models (if any are in the generated scene).
|
|
24
20
|
|
|
25
21
|
* ``montage_wrapper``: STIPS uses ``montage`` to generate mosaics. It is
|
|
26
22
|
only imported if STIPS is asked to generate a multi-detector image.
|
|
@@ -49,14 +45,18 @@ STIPS Requirements
|
|
|
49
45
|
Finally, STIPS requires a set of data files whose location is marked by setting the
|
|
50
46
|
environment variable ``stips_data``, which will be installed as part of these instructions.
|
|
51
47
|
|
|
52
|
-
Installing Using
|
|
53
|
-
|
|
48
|
+
Installing Using a Package Manager and Source Code
|
|
49
|
+
##################################################
|
|
54
50
|
|
|
55
|
-
STIPS can be installed using the
|
|
56
|
-
|
|
57
|
-
`
|
|
58
|
-
|
|
59
|
-
|
|
51
|
+
STIPS can be installed using one of the YAML files provided in its source code.
|
|
52
|
+
These YAML files define an environment that a package manager like
|
|
53
|
+
`Micromamba <https://mamba.readthedocs.io/en/latest/installation/micromamba-installation.html>`_,
|
|
54
|
+
`Mamba <https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html>`_,
|
|
55
|
+
`Conda <https://docs.anaconda.com/anaconda/install/>`_, or another can read and
|
|
56
|
+
install on your machine.
|
|
57
|
+
(If you don't have a package manager, follow any of the preceding links for
|
|
58
|
+
installation instructions.) The YAML files include all packages required by
|
|
59
|
+
STIPS. Please follow the steps below to install STIPS.
|
|
60
60
|
|
|
61
61
|
.. _installing-as-a-user:
|
|
62
62
|
|
|
@@ -74,15 +74,19 @@ Installing as a User
|
|
|
74
74
|
|
|
75
75
|
#. The environment file can be used in two ways:
|
|
76
76
|
|
|
77
|
-
* To create a new
|
|
77
|
+
* To create a new environment named ``stips``::
|
|
78
78
|
|
|
79
79
|
conda env create -f environment.yml
|
|
80
80
|
conda activate stips
|
|
81
81
|
|
|
82
82
|
|
|
83
|
-
* Or, to install to or update an existing
|
|
83
|
+
* Or, to install to or update an existing environment::
|
|
84
|
+
|
|
85
|
+
conda env update --name <EXISTING-ENV> --file environment.yml
|
|
84
86
|
|
|
85
|
-
|
|
87
|
+
(If you are using mamba, substitute it for ``conda`` in the commands above.
|
|
88
|
+
If you are using micromamba, substitute it for ``conda`` and also remove
|
|
89
|
+
``env`` in the commands above.)
|
|
86
90
|
|
|
87
91
|
Installing as a Developer
|
|
88
92
|
*************************
|
|
@@ -94,6 +98,13 @@ Installing as a Developer
|
|
|
94
98
|
|
|
95
99
|
.. _downloading-required-ref-data:
|
|
96
100
|
|
|
101
|
+
Installing with pip
|
|
102
|
+
*******************
|
|
103
|
+
|
|
104
|
+
While it is possible to install STIPS with ``pip`` instead of a package manager,
|
|
105
|
+
we recommend the latter due to the aforementioned warning about using ``pip``
|
|
106
|
+
with the ``esutil`` package.
|
|
107
|
+
|
|
97
108
|
Downloading Required Reference Data
|
|
98
109
|
************************************
|
|
99
110
|
|
|
@@ -107,7 +118,10 @@ You will need to download the data and add them to your environmental path.
|
|
|
107
118
|
export stips_data="<absolute_path_to_this_folder>/ref_data/stips_data"
|
|
108
119
|
export STPSF_PATH="<absolute_path_to_this_folder>/ref_data/stpsf-data"
|
|
109
120
|
export PYSYN_CDBS="<absolute_path_to_this_folder>/ref_data/grp/redcat/trds"
|
|
110
|
-
export pandeia_refdata="<absolute_path_to_this_folder>/ref_data/pandeia_data-
|
|
121
|
+
export pandeia_refdata="<absolute_path_to_this_folder>/ref_data/pandeia_data-xxxx.x_roman"
|
|
122
|
+
|
|
123
|
+
# if your Pandeia installation is 2026.1 or higher, add the following:
|
|
124
|
+
export PSF_DIR="<absolute_path_to_this_folder>/ref_data/pandeia_psfs-xxxx.x_roman"
|
|
111
125
|
|
|
112
126
|
.. note::
|
|
113
127
|
|
|
@@ -115,7 +129,7 @@ You will need to download the data and add them to your environmental path.
|
|
|
115
129
|
|
|
116
130
|
2. ``cd`` into the ``ref_data`` directory in your ``STScI-STIPS`` clone.
|
|
117
131
|
|
|
118
|
-
3. Run the following code (after ensuring your ``stips``
|
|
132
|
+
3. Run the following code (after ensuring your package manager's ``stips`` environment is active)::
|
|
119
133
|
|
|
120
134
|
python retrieve_stips_data.py
|
|
121
135
|
|
|
@@ -132,9 +146,8 @@ Testing Installation
|
|
|
132
146
|
|
|
133
147
|
To test if all the required files have been installed, please import STIPS in Python::
|
|
134
148
|
|
|
135
|
-
bash-3.2$
|
|
136
|
-
Python 3.11.
|
|
137
|
-
[Clang 16.0.6 ] on darwin
|
|
149
|
+
bash-3.2$ python3
|
|
150
|
+
Python 3.11.15 | packaged by conda-forge | (main, Mar 5 2026, 16:58:53) [Clang 19.1.7 ] on darwin
|
|
138
151
|
Type "help", "copyright", "credits" or "license" for more information.
|
|
139
152
|
|
|
140
153
|
>>> import stips
|
|
@@ -145,13 +158,13 @@ You should receive an output of the following form:
|
|
|
145
158
|
|
|
146
159
|
.. code-block:: text
|
|
147
160
|
|
|
148
|
-
STIPS Version x.y.z with Data Version
|
|
161
|
+
STIPS Version x.y.z with Data Version a.b.c at /Some/Path/To/stips_data.
|
|
149
162
|
|
|
150
|
-
STIPS Grid Generated with x.y.z
|
|
163
|
+
STIPS Grid Generated with STIPS Version x.y.z.
|
|
151
164
|
|
|
152
|
-
Pandeia
|
|
165
|
+
Pandeia Version YYYY.n with Data Version YYYY.n at /Some/Path/To/pandeia_refdata.
|
|
153
166
|
|
|
154
|
-
STPSF Version d.e.f with Data Version d.e.f at /Some/Path/To/stpsf_data_path
|
|
167
|
+
STPSF Version d.e.f with Data Version d.e.f at /Some/Path/To/stpsf_data_path.
|
|
155
168
|
|
|
156
169
|
|
|
157
170
|
Ignore the following warning message if it appears:
|
|
@@ -256,8 +256,9 @@ Mixed Catalog
|
|
|
256
256
|
A Mixed catalog is identical to an Internal catalog, except that it
|
|
257
257
|
contains one additional column:
|
|
258
258
|
|
|
259
|
-
* Units (one of 'p' for photons/s, 'e' for
|
|
260
|
-
for counts/s.
|
|
259
|
+
* Units (one of 'p' for photons/s, 'e' for ergs/s, 'j' for Jansky,
|
|
260
|
+
or 'c' for counts/s. Because STIPS assumes a quantum efficiency and gain of 1,
|
|
261
|
+
data in electrons/s can be treated as equivalent to photons/s.)
|
|
261
262
|
|
|
262
263
|
In order to identify the catalog as a Mixed catalog, the following metadata
|
|
263
264
|
must be present:
|
|
@@ -84,25 +84,22 @@ observation_default_background (default *0.0*)
|
|
|
84
84
|
The default sky background in counts/s/detector pixel. Currently this keyword can be set to:
|
|
85
85
|
|
|
86
86
|
* any integer or floating point value, in which case that value will be
|
|
87
|
-
used directly.
|
|
87
|
+
used directly. The default value is 0.
|
|
88
88
|
|
|
89
89
|
* any of the string values 'none', 'low', 'avg', or 'high'. In this
|
|
90
90
|
case, 'none' is always treated as zero, and for any other keyword if the
|
|
91
91
|
value is defined for the instrument/detector selected, that value will
|
|
92
92
|
be used. If no such value can be found, the background will be set to 0.
|
|
93
93
|
|
|
94
|
-
|
|
95
|
-
|
|
94
|
+
* the string value 'pandeia', which will use Pandeia to calculate the total
|
|
95
|
+
background for the active filter. Pandeia calculates backgrounds in
|
|
96
|
+
electrons/s, so STIPS converts the value to counts/s for consistency. The
|
|
97
|
+
conversion assumes a quantum yield of 1, where photons are equivalent to
|
|
98
|
+
electrons.
|
|
96
99
|
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
from online, ``$DATA`` indicates that the value should be taken from a
|
|
101
|
-
directory named ``background`` in the ``stips_data`` directory. Otherwise,
|
|
102
|
-
the value should be the path to a directory containing a local cache of the
|
|
103
|
-
data. If used as a keyword argument, ``background_location`` or
|
|
104
|
-
``jbt_location`` can be used instead of ``observation_jbt_location`` for
|
|
105
|
-
historical reasons.
|
|
100
|
+
Outside of a configuration file (e.g., as a keyword argument to a STIPS
|
|
101
|
+
Python object), ``background`` should be used instead of
|
|
102
|
+
``observation_default_background`` for historical reasons.
|
|
106
103
|
|
|
107
104
|
observation_distortion_enable (default *false*)
|
|
108
105
|
Whether co-ordinate distortion information should be included in the
|
|
@@ -114,12 +111,6 @@ observation_distortion_enable (default *false*)
|
|
|
114
111
|
PSF Convolution Configuration
|
|
115
112
|
-----------------------------
|
|
116
113
|
|
|
117
|
-
psf_grid_default_size (default *1*)
|
|
118
|
-
What size PSF grid should be created. Note that this value is expressed as
|
|
119
|
-
a side length, so if psf_grid_default_size is set to n, STPSF will create
|
|
120
|
-
a total of n^2 PSF images. If used as a keyword argument, ``psf_grid_size``
|
|
121
|
-
can be used instead of ``psf_grid_default_size`` for historical reasons.
|
|
122
|
-
|
|
123
114
|
psf_cache_enable (default *true*)
|
|
124
115
|
Whether PSF grids created by STPSF should be cached after creation for
|
|
125
116
|
potential re-use.
|
|
@@ -139,6 +130,9 @@ psf_convolution_max_size (default *8192*)
|
|
|
139
130
|
argument, ``convolve_size`` can be used instead of
|
|
140
131
|
``psf_convolution_max_size`` for historical reasons.
|
|
141
132
|
|
|
133
|
+
The side length of the PSF grid created by STIPS was formerly editable with a
|
|
134
|
+
PSF convolution configuration option called ``psf_grid_size``. **It is now
|
|
135
|
+
fixed at 3.**
|
|
142
136
|
|
|
143
137
|
Error Residual Configuration
|
|
144
138
|
----------------------------
|
|
@@ -19,7 +19,6 @@ name: stips
|
|
|
19
19
|
|
|
20
20
|
channels:
|
|
21
21
|
- conda-forge
|
|
22
|
-
- astropy
|
|
23
22
|
|
|
24
23
|
dependencies:
|
|
25
24
|
# Base dependencies
|
|
@@ -31,11 +30,15 @@ dependencies:
|
|
|
31
30
|
|
|
32
31
|
- pip:
|
|
33
32
|
# Special Modules. These are temporary entries and require documentation.
|
|
34
|
-
|
|
33
|
+
|
|
34
|
+
# poppy 1.0.3 fixes a bug with how poppy calls factorial with non-integer
|
|
35
|
+
# values. through v2.2.0, stpsf only requires poppy 1.0.0, so a
|
|
36
|
+
# separate peg for poppy is necessary to guarantee the presence of the fix.
|
|
37
|
+
- poppy>=1.0.3
|
|
35
38
|
|
|
36
39
|
# Core Modules
|
|
37
40
|
- stpsf>=2.0.0
|
|
38
|
-
- pandeia.engine>=
|
|
41
|
+
- pandeia.engine>=2025.9
|
|
39
42
|
- synphot>=1.1.1
|
|
40
43
|
- stsynphot>=1.1.0
|
|
41
44
|
- soc_roman_tools
|
|
@@ -58,13 +61,11 @@ dependencies:
|
|
|
58
61
|
- docutils
|
|
59
62
|
- sphinx
|
|
60
63
|
- sphinx_rtd_theme
|
|
61
|
-
|
|
62
|
-
# (install stsci_rtd_theme from master until a post 1.0 release occurs
|
|
63
|
-
# to prevent issues with bullets in the documentation)
|
|
64
|
-
- git+https://github.com/spacetelescope/stsci_rtd_theme.git@master
|
|
64
|
+
- stsci_rtd_theme
|
|
65
65
|
- sphinx_automodapi
|
|
66
66
|
- sphinx_autoapi
|
|
67
67
|
- sphinx_astropy
|
|
68
|
+
- sphinx_issues
|
|
68
69
|
|
|
69
70
|
# Testing
|
|
70
71
|
- tox
|
|
@@ -22,7 +22,6 @@ name: stips_dev
|
|
|
22
22
|
|
|
23
23
|
channels:
|
|
24
24
|
- conda-forge
|
|
25
|
-
- astropy
|
|
26
25
|
|
|
27
26
|
dependencies:
|
|
28
27
|
# Base dependencies
|
|
@@ -33,18 +32,16 @@ dependencies:
|
|
|
33
32
|
- esutil # installed from conda because you need the pre-compiled binaries.
|
|
34
33
|
|
|
35
34
|
- pip:
|
|
36
|
-
#
|
|
37
35
|
# Special Modules. These are temporary entries and require documentation.
|
|
38
|
-
|
|
39
|
-
# poppy 1.0.3 fixes a bug with
|
|
40
|
-
# values.
|
|
41
|
-
#
|
|
42
|
-
|
|
43
|
-
- poppy==1.0.3
|
|
36
|
+
|
|
37
|
+
# poppy 1.0.3 fixes a bug with how poppy calls factorial with non-integer
|
|
38
|
+
# values. through v2.2.0, stpsf only requires poppy 1.0.0, so a
|
|
39
|
+
# separate peg for poppy is necessary to guarantee the presence of the fix.
|
|
40
|
+
- poppy>=1.0.3
|
|
44
41
|
|
|
45
42
|
# Core Modules
|
|
46
43
|
- stpsf>=2.0.0
|
|
47
|
-
- pandeia.engine>=
|
|
44
|
+
- pandeia.engine>=2025.9
|
|
48
45
|
- synphot>=1.1.1
|
|
49
46
|
- stsynphot>=1.1.0
|
|
50
47
|
- soc_roman_tools
|
|
@@ -67,13 +64,11 @@ dependencies:
|
|
|
67
64
|
- docutils
|
|
68
65
|
- sphinx
|
|
69
66
|
- sphinx_rtd_theme
|
|
70
|
-
|
|
71
|
-
# (install stsci_rtd_theme from master until a post 1.0 release occurs
|
|
72
|
-
# to prevent issues with bullets in the documentation)
|
|
73
|
-
- git+https://github.com/spacetelescope/stsci_rtd_theme.git@master
|
|
67
|
+
- stsci_rtd_theme
|
|
74
68
|
- sphinx_automodapi
|
|
75
69
|
- sphinx_autoapi
|
|
76
70
|
- sphinx_astropy
|
|
71
|
+
- sphinx_issues
|
|
77
72
|
|
|
78
73
|
# Testing
|
|
79
74
|
- tox
|
|
@@ -694,7 +694,7 @@
|
|
|
694
694
|
"source": [
|
|
695
695
|
"## Conclusion\n",
|
|
696
696
|
"\n",
|
|
697
|
-
"This concludes the first portion of the advanced tutorial. For information on PSFs, please see STIPS Advanced II. If you have further questions, check out the [STIPS documentation](https://stips.readthedocs.io/en/latest/)
|
|
697
|
+
"This concludes the first portion of the advanced tutorial. For information on PSFs, please see STIPS Advanced II. If you have further questions, check out the [STIPS documentation](https://stips.readthedocs.io/en/latest/). Direct any remaining questions to the [Roman Help Desk](https://stsci.service-now.com/roman) by logging into your account and then selecting \"Get Help\" and \"Simulators and Tools\". Make sure to mention \"STIPS\" in the subject line."
|
|
698
698
|
]
|
|
699
699
|
}
|
|
700
700
|
],
|
|
@@ -366,7 +366,7 @@
|
|
|
366
366
|
"source": [
|
|
367
367
|
"## Conclusion\n",
|
|
368
368
|
"\n",
|
|
369
|
-
"This concludes the second portion of the advanced tutorial. If you have further questions, check out the [STIPS documentation](https://stips.readthedocs.io/en/latest/)
|
|
369
|
+
"This concludes the second portion of the advanced tutorial. If you have further questions, check out the [STIPS documentation](https://stips.readthedocs.io/en/latest/). Direct any remaining questions to the [Roman Help Desk](https://stsci.service-now.com/roman) by logging into your account and then selecting \"Get Help\" and \"Simulators and Tools\". Make sure to mention \"STIPS\" in the subject line."
|
|
370
370
|
]
|
|
371
371
|
}
|
|
372
372
|
],
|
|
@@ -4,8 +4,9 @@
|
|
|
4
4
|
# export stips_data="<absolute_path_to_this_folder>/ref_data/stips_data"
|
|
5
5
|
# export STPSF_PATH="<absolute_path_to_this_folder>/ref_data/stpsf-data"
|
|
6
6
|
# export PYSYN_CDBS="<absolute_path_to_this_folder>/ref_data/grp/redcat/trds"
|
|
7
|
-
# export pandeia_refdata="<absolute_path_to_this_folder>/ref_data/pandeia_data-
|
|
8
|
-
#
|
|
7
|
+
# export pandeia_refdata="<absolute_path_to_this_folder>/ref_data/pandeia_data-XXXX.X-roman"
|
|
8
|
+
# # if your Pandeia installation is 2026.1 or higher, add the following:
|
|
9
|
+
# export PSF_DIR="<absolute_path_to_this_folder>/ref_data/pandeia_psfs-XXXX.X-roman"
|
|
9
10
|
#
|
|
10
11
|
# 2. In the ref_data folder, run the script: python retrieve_stips_data.py
|
|
11
12
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
[metadata]
|
|
2
2
|
name = stips
|
|
3
|
-
version = 2.3
|
|
3
|
+
version = 2.3.1
|
|
4
4
|
author = Space Telescope Science Institute
|
|
5
5
|
author_email = york@stsci.edu
|
|
6
6
|
description = STIPS is the Space Telescope Imaging Product Simulator.
|
|
@@ -8,7 +8,7 @@ long_description = STIPS is the Space Telescope Imaging Product Simulator. It is
|
|
|
8
8
|
license = BSD 3-Clause
|
|
9
9
|
url = https://github.com/spacetelescope/STScI-STIPS
|
|
10
10
|
edit_on_github = False
|
|
11
|
-
github_project =
|
|
11
|
+
github_project = spacetelescope/STScI-STIPS
|
|
12
12
|
python_requires = ">=3.10"
|
|
13
13
|
|
|
14
14
|
[options]
|
|
@@ -23,7 +23,8 @@ install_requires =
|
|
|
23
23
|
synphot>=1.1.1
|
|
24
24
|
stsynphot>=1.1.0
|
|
25
25
|
stpsf>=2.0.0
|
|
26
|
-
|
|
26
|
+
poppy>=1.0.3
|
|
27
|
+
pandeia.engine>=2025.9
|
|
27
28
|
montage-wrapper
|
|
28
29
|
pyyaml
|
|
29
30
|
soc_roman_tools
|