stpsf

Space Telescope PSF Simulation Tool

https://github.com/spacetelescope/stpsf

Science Score: 75.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 3 DOI reference(s) in README
✓
Academic publication links
Links to: zenodo.org
○
Academic email domains
✓
Institutional organization owner
Organization spacetelescope has institutional domain (www.stsci.edu)
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (12.9%) to scientific vocabulary

Keywords

astronomy jwst optics python

Last synced: 6 months ago · JSON representation ·

Repository

Space Telescope PSF Simulation Tool

Basic Info

Host: GitHub
Owner: spacetelescope
License: bsd-3-clause
Language: Jupyter Notebook
Default Branch: develop
Homepage: https://stpsf.readthedocs.io/en/latest/
Size: 148 MB

Statistics

Stars: 7
Watchers: 8
Forks: 11
Open Issues: 36
Releases: 4

Topics

astronomy jwst optics python

Created about 1 year ago · Last pushed 6 months ago

Metadata Files

Readme Contributing License Code of conduct Citation

README.rst

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

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.15747364.svg
  :target: https://doi.org/10.5281/zenodo.15747364

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


**STPSF HAS BEEN MIGRATED FROM WEBBPSF**

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 (Cycle 10) Roman WFI optical model was calculated by Goddard
   Space Flight Center in September 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.

Owner

Name: Space Telescope Science Institute
Login: spacetelescope
Kind: organization
Email: help@stsci.edu
Location: Baltimore, MD

Website: http://www.stsci.edu
Repositories: 305
Profile: https://github.com/spacetelescope

STScI is operated by AURA for NASA

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: STPSF
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Marshall
    family-names: Perrin
    affiliation: Space Telescope Science Institute
    orcid: 'https://orcid.org/0000-0002-3191-8151'
  - given-names: Joseph
    family-names: Long
    affiliation: Flatiron Institute
    orcid: 'https://orcid.org/0000-0003-1905-9443'
  - given-names: Shannon
    family-names: Osborne
    affiliation: Fred Hutchinson Cancer Center
    orcid: 'https://orcid.org/0009-0001-8609-1518'
  - given-names: Robel
    family-names: Geda
    affiliation: Princeton University
    orcid: 'https://orcid.org/0000-0003-1509-9966'
  - given-names: Bradley
    family-names: Sappington
    email: bsappington@stsci.edu
    affiliation: Space Telescope Science Institute
    orcid: 'https://orcid.org/0009-0008-2911-2555'
  - given-names: Marcio
    family-names: Meléndez
    email: melendez@stsci.edu
    affiliation: Space Telescope Science Institute
    orcid: 'https://orcid.org/0000-0001-8485-0325'
  - given-names: Charles-Philippe
    family-names: Lajoie
    affiliation: Space Telescope Science Institute
    orcid: 'https://orcid.org/0009-0003-3993-8338'
  - given-names: Jarron
    family-names: Leisenring
  - given-names: Neil
    family-names: Zimmerman
  - given-names: Keira
    family-names: Brooks
  - given-names: O. Justin
    family-names: Otor
    orcid: 'https://orcid.org/0000-0002-4679-5692'
  - given-names: Trey
    family-names: Kulp
  - given-names: Lauren
    family-names: Chambers
  - given-names: Alden
    family-names: Jurling
identifiers:
  - type: doi
    value: 10.5281/zenodo.15747364
repository-code: 'https://github.com/spacetelescope/stpsf'
url: 'https://github.com/spacetelescope/stpsf'
abstract: >-
  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.
license: BSD-3-Clause
version: 2.1.0
references:
  - type: article
    authors:
      - given-names: Marshall D.
        family-names: Perrin
      - given-names: Anand
        family-names: Sivaramakrishnan
      - given-names: Charles-Philippe
        family-names: Lajoie
      - given-names: Erin
        family-names: Elliott
      - given-names: Laurent
        family-names: Pueyo
      - given-names: Swara
        family-names: Ravindranath
      - given-names: Loïc
        family-names: Albert
    title: "Updated point spread function simulations for JWST with WebbPSF"
    journal: "Proc. SPIE"
    volume: 9143
    year: 2014
    doi: 10.1117/12.2056689
    url: https://doi.org/10.1117/12.2056689

  - type: article
    authors:
      - given-names: Marshall D.
        family-names: Perrin
      - given-names: Rémi
        family-names: Soummer
      - given-names: Erin M.
        family-names: Elliott
      - given-names: Matthew D.
        family-names: Lallo
      - given-names: Anand
        family-names: Sivaramakrishnan
    title: "Simulating point spread functions for the James Webb Space Telescope with WebbPSF"
    journal: "Proc. SPIE"
    volume: 8442
    year: 2012
    doi: 10.1117/12.925230
    url: https://doi.org/10.1117/12.925230

GitHub Events

Total

Fork event: 9
Create event: 29
Issues event: 72
Release event: 4
Watch event: 7
Delete event: 18
Issue comment event: 92
Member event: 6
Public event: 1
Push event: 78
Pull request review comment event: 43
Pull request review event: 72
Pull request event: 82

Last Year

Fork event: 9
Create event: 29
Issues event: 72
Release event: 4
Watch event: 7
Delete event: 18
Issue comment event: 92
Member event: 6
Public event: 1
Push event: 78
Pull request review comment event: 43
Pull request review event: 72
Pull request event: 82

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 23
Total pull requests: 39
Average time to close issues: over 1 year
Average time to close pull requests: 21 days
Total issue authors: 14
Total pull request authors: 8
Average comments per issue: 2.43
Average comments per pull request: 1.18
Merged pull requests: 21
Bot issues: 0
Bot pull requests: 7

Past Year

Issues: 14
Pull requests: 39
Average time to close issues: 3 months
Average time to close pull requests: 21 days
Issue authors: 10
Pull request authors: 8
Average comments per issue: 0.79
Average comments per pull request: 1.18
Merged pull requests: 21
Bot issues: 0
Bot pull requests: 7

View more stats

Top Authors

Issue Authors

mperrin (22)
obi-wan76 (4)
ariedel (2)
LouisDesdoigts (2)
Skyhawk172 (2)
vandalt (2)
eteq (2)
BradleySappington (1)
JarronL (1)
kjbrooks (1)
ojustino (1)
kulpster85 (1)
zacharyburnett (1)
amn3142 (1)
dlakaplan (1)

Pull Request Authors

BradleySappington (20)
obi-wan76 (7)
dependabot[bot] (7)
mperrin (7)
ojustino (2)
tonysohn (1)
Skyhawk172 (1)
kulpster85 (1)

Top Labels

Issue Labels

enhancement (9) bug (6) data_files (1) Roman (1)

Pull Request Labels

dependencies (7) python (2) Roman (2) bug (1) documentation (1)

Packages

Total packages: 1
Total downloads:
- pypi 5,288 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 4
Total maintainers: 2

pypi.org: stpsf

Creates simulated point spread functions for Space Telescopes (James Webb, Roman)

Homepage: http://stpsf.readthedocs.io/
Documentation: https://stpsf.readthedocs.io/
License: bsd-3-clause
Latest release: 2.1.0
published 8 months ago

Versions: 4
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 5,288 Last month

Rankings

Dependent packages count: 10.0%

Average: 33.1%

Dependent repos count: 56.2%

Maintainers (2)

stsci_maintainer BradSappington