Skip to content

Commit

Permalink
Merge pull request #178 from ojustino/master-to-main-swaps
Browse files Browse the repository at this point in the history
Change remaining mentions of master to main
  • Loading branch information
gmzsebastian authored May 13, 2024
2 parents dad5dcd + a67406d commit 91a52a5
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# STScI-STIPS

[![Build Status](https://travis-ci.com/spacetelescope/STScI-STIPS.svg?branch=master)](https://travis-ci.com/spacetelescope/STScI-STIPS)
[![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)

For documentation and installation instructions please visit https://stips.readthedocs.io
Expand All @@ -12,32 +12,32 @@ For documentation and installation instructions please visit https://stips.readt

## Overview

STIPS is the Space Telescope Imaging Product Simulator. It is designed to create
simulations of full-detector post-pipeline astronomical scenes for the Nancy Grace Roman
Space Telescope's Wide-Field Instrument (WFI). STIPS has the ability to add
STIPS is the Space Telescope Imaging Product Simulator. It is designed to create
simulations of full-detector post-pipeline astronomical scenes for the Nancy Grace Roman
Space Telescope's Wide-Field Instrument (WFI). STIPS has the ability to add
instrumental distortion (if available) as well as calibration residuals from flatfields,
dark currents, and cosmic rays. It automatically includes Poisson noise and readout noise.
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 of Level 2 (L2) images, and is provided 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.

STIPS does not start with Level 1 (L1) images and propagate instrumental calibrations
STIPS does not start with Level 1 (L1) images and propagate instrumental calibrations
through the simulations. While it does have the ability to add error residuals (representing
the remaining uncertainty after pipeline calibration), these residuals are not validated
against actual pipeline calibrations of L1 images. STIPS is not the ideal choice if
extremely good instrumental accuracy is needed. Pandeia is the preferred tool for
the remaining uncertainty after pipeline calibration), these residuals are not validated
against actual pipeline calibrations of L1 images. STIPS is not the ideal choice if
extremely good instrumental accuracy is needed. Pandeia is the preferred tool for
high-accuracy observations.

Developed by Brian York ([@york-stsci](https://github.com/york-stsci)),
Robel Geda ([@robelgeda](https://github.com/robelgeda)), and
Robel Geda ([@robelgeda](https://github.com/robelgeda)), and
O. Justin Otor ([@ojustino](https://github.com/ojustino)).
Python ePSF code developed by
Python ePSF code developed by
Sebastian Gomez ([@gmzsebastian](https://github.com/gmzsebastian)) based on Fortran code
developed by Andrea Bellini ([@AndreaBellini](https://github.com/AndreaBellini)).

Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ def setup(app):
if versionmod.version.release:
edit_on_github_branch = "v" + versionmod.version.version
else:
edit_on_github_branch = "master"
edit_on_github_branch = "main"

edit_on_github_source_root = ""
edit_on_github_doc_root = "docs"
Expand Down

0 comments on commit 91a52a5

Please sign in to comment.