Metadata-Version: 2.1
Name: stpsf
Version: 1.5.2
Summary: Creates simulated point spread functions for Space Telescopes (James Webb, Roman)
Author-email: Association of Universities for Research in Astronomy <help@stsci.edu>
License: BSD 3-Clause License
        
        Copyright (c) 2010-2024, Space Telescope Science Institute, AURA
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        * Redistributions of source code must retain the above copyright notice, this
          list of conditions and the following disclaimer.
        
        * Redistributions in binary form must reproduce the above copyright notice,
          this list of conditions and the following disclaimer in the documentation
          and/or other materials provided with the distribution.
        
        * Neither the name of the copyright holder nor the names of its
          contributors may be used to endorse or promote products derived from
          this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: Homepage, http://stpsf.readthedocs.io/
Project-URL: github_project, https://github.com/spacetelescope/stpsf
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE.md
Requires-Dist: numpy>=1.21.6
Requires-Dist: scipy>=1.5.0
Requires-Dist: matplotlib>=3.2.0
Requires-Dist: astropy>=5.1.0
Requires-Dist: photutils>=1.10.0
Requires-Dist: poppy>=1.0.0
Requires-Dist: pysiaf>=0.23.3
Requires-Dist: synphot>=1.0.0
Requires-Dist: astroquery>=0.4.6
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-astropy; extra == "test"
Provides-Extra: docs
Requires-Dist: nbsphinx; extra == "docs"
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: stsci_rtd_theme; extra == "docs"
Requires-Dist: sphinx-astropy; extra == "docs"
Requires-Dist: sphinx-automodapi; extra == "docs"
Requires-Dist: sphinx-issues; extra == "docs"
Requires-Dist: tomli; python_version < "3.11" and extra == "docs"

STPSF: Simulated Point Spread Functions for the James Webb and Nancy Grace Roman Space Telescopes
===================================================================================================

.. image:: https://github.com/spacetelescope/stpsf/blob/stable/docs/readme_fig.png?raw=true

.. image:: https://img.shields.io/pypi/v/stpsf.svg
   :target: https://pypi.python.org/pypi/stpsf
   :alt: Badge showing current released PyPI version

.. image:: https://github.com/spacetelescope/stpsf/workflows/CI/badge.svg?branch=develop
   :target: https://github.com/spacetelescope/stpsf/actions
   :alt: Github Actions CI Status

.. image:: https://codecov.io/gh/spacetelescope/stpsf/branch/master/graph/badge.svg
  :target: https://codecov.io/gh/spacetelescope/stpsf

.. |Documentation Status| image:: https://img.shields.io/readthedocs/stpsf/latest.svg?logo=read%20the%20docs&logoColor=white&label=Docs&version=latest
   :target: https://stpsf.readthedocs.io/en/latest/
   :alt: Documentation Status

.. image:: https://img.shields.io/badge/ascl-1504.007-blue.svg?colorB=262255
   :target: http://ascl.net/1504.007


**ADVISORY:  STPSF IS CURRENTLY BEING MIGRATED FROM WEBBPSF - THIS REPOSITORY IS NOT READY FOR USE**

STPSF produces simulated PSFs for the James Webb Space Telescope, NASA's
flagship infrared space telescope. STPSF can simulate images for any of the
four science instruments plus the fine guidance sensor, including both direct
imaging, coronagraphic, and spectroscopic modes.

STPSF 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.

.. 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 STPSF.

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://stpsf.readthedocs.io

STPSF requires input data for its simulations, including optical path
difference (OPD) maps, filter transmission curves, and coronagraph Lyot mask
shapes. These data files are not included in this source distribution.
Please see the documentation to download the required data files.
