stips 2.2.2__tar.gz

stips-2.2.2/.github/workflows/ci_workflows.yml

@@ -0,0 +1,81 @@
+# GitHub Actions workflow for testing and continuous integration.
+
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  ci_tests:
+    name: ${{ matrix.name }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        include:
+
+          - name: Python 3.10
+            os: ubuntu-latest
+            python: "3.10"
+
+          - name: Python 3.11
+            os: ubuntu-latest
+            python: 3.11
+
+          - name: Python 3.11 Mac
+            os: macos-latest
+            python: 3.11
+
+          - name: Python Long
+            os: ubuntu-latest
+            python: 3.11
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+
+    - name: Set up environment
+      uses: conda-incubator/setup-miniconda@v2
+      with:
+        activate-environment: stips
+        environment-file: environment.yml
+        python-version: ${{ matrix.python }}
+        auto-activate-base: false
+        miniconda-version: "latest"  # Ensure Miniconda is installed if not found
+
+    - name: Test with tox
+      shell: bash -l {0}
+      if: ${{ matrix.name != 'Python Long' }}
+      run: |
+        tox -e test
+
+    - name: Test slow tests with pytest
+      shell: bash -l {0}
+      if: ${{ matrix.name == 'Python Long' }}
+      run: |
+        tox -e test-all
+
+  docs_test:
+    name: "docs_test"
+    runs-on: ubuntu-latest
+    steps:
+
+    - name: Checkout code
+      uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+
+    - name: Set up environment
+      uses: conda-incubator/setup-miniconda@v2
+      with:
+        activate-environment: stips
+        environment-file: environment.yml
+        python-version: 3.11
+        auto-activate-base: false
+
+    - name: Build Docs
+      shell: bash -l {0}
+      run: |
+        tox -e build_docs

stips-2.2.2/.gitignore

@@ -0,0 +1,226 @@
+###################
+##    AstroPy    ##
+###################
+
+# Compiled files
+*.py[cod]
+*.a
+*.o
+*.so
+__pycache__
+
+# Ignore .c files by default to avoid including generated code. If you want to
+# add a non-generated .c extension, use `git add -f filename.c`.
+*.c
+
+# Other generated files
+*/version.py
+*/cython_version.py
+htmlcov
+.coverage
+MANIFEST
+.ipynb_checkpoints
+
+# Sphinx
+docs/api
+docs/_build
+docs/_static
+
+# Eclipse editor project files
+.project
+.pydevproject
+.settings
+
+# Pycharm editor project files
+.idea
+
+# Floobits project files
+.floo
+.flooignore
+
+# Packages/installer info
+*.egg
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+distribute-*.tar.gz
+
+# Other
+.cache
+.tox
+.*.sw[op]
+*~
+.project
+.pydevproject
+.settings
+
+# Mac OSX
+.DS_Store
+
+
+###################
+##    Custom     ##
+###################
+
+# Compiled source #
+###################
+*.com
+*.class
+*.dll
+*.exe
+*.o
+*.so
+
+# Packages #
+############
+# it's better to unpack these files and commit the raw source
+# git has its own built in compression methods
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# Logs and databases #
+######################
+*.log
+*.sql
+*.sqlite
+
+# OS generated files #
+######################
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Byte-compiled / optimized / DLL files #
+#########################################
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging #
+############################
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller                                                                   #
+#  Usually these files are written by a python script from a template           #
+#  before PyInstaller builds the exe, so as to inject date/other infos into it. #
+#################################################################################
+*.manifest
+*.spec
+
+# Installer logs #
+##################
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports #
+################################
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+ref_data/
+
+# Translations #
+################
+*.mo
+*.pot
+
+# Django stuff: #
+#################
+*.log
+local_settings.py
+
+# Flask stuff: #
+################
+instance/
+.webassets-cache
+
+# Scrapy stuff: #
+#################
+.scrapy
+
+# Sphinx documentation #
+########################
+docs/_build/
+
+# PyBuilder #
+#############
+target/
+
+# Jupyter Notebook #
+####################
+.ipynb_checkpoints
+
+# pyenv #
+#########
+.python-version
+
+# celery beat schedule file #
+#############################
+celerybeat-schedule
+
+# SageMath parsed files #
+#########################
+*.sage.py
+
+# Environments #
+################
+.env
+.venv
+env/
+venv/
+ENV/
+
+# Spyder project settings #
+###########################
+.spyderproject
+.spyproject
+
+# Rope project settings #
+#########################
+.ropeproject
+
+# mkdocs documentation #
+########################
+/site
+
+# mypy #
+########
+.mypy_cache/

stips-2.2.2/.readthedocs.yaml

@@ -0,0 +1,33 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04 # (now required to build RTD)
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "20"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#   - pdf
+#   - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: docs/requirements.txt

stips-2.2.2/.rtd-environment.yml

@@ -0,0 +1,22 @@
+name: stips
+
+channels:
+  - conda-forge
+  - astropy
+  - http://ssb.stsci.edu/astroconda
+  - defaults
+
+dependencies:
+  - python>=3.7
+  - astropy
+
+  # Docs
+  - sphinx
+  - docutils
+  - sphinx_rtd_theme
+  - stsci_rtd_theme
+
+  - pip:
+    # Docs
+    - astropy_helpers
+    - sphinx_astropy

stips-2.2.2/CHANGES.rst

@@ -0,0 +1,83 @@
+#############
+Release Notes
+#############
+
+Version History and Change Log
+------------------------------
+
+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
+- Updated WebbPSF version to be >= 1.1.1 instead of == 1.1.1
+- Updated synphot>=1.1.1 and stsynphot>=1.1.0 from forced to specific version.
+
+Version 2.2.0
+=============
+- Added a functionality to allow for faster simulations of extended sources.
+- Fixed a bug related to the simulation of extended sources.
+- Fixed a bug related to the WCS.
+- Updated pandeia to version 3.1 and its corresponding reference files.
+- Changed the minimum required Python version to 3.10
+
+Version 2.1.0
+=============
+- Updated the Flux PHOTFNU values to match Pandeia
+- Updated the background and noise estimates to use Pandeia
+- Updated webbpsf to version 1.1
+- Updated pandeia to version 2.0
+
+Version 2.0.0
+=============
+
+- STIPS now uses an ePSF, and calculates source appearance on a per-source basis
+- Dropped support for python 2, and python <= 3.7
+- Dropped support for HST and JWST instruments
+- Dropped support for jbt background tool, as its results are JWST-specific
+- Updated pandeia to 1.7
+- Updated webbpsf to 1.0.0
+- Dropped astropy helpers code
+
+
+Version 1.0.8
+=============
+*2020 May 22*
+
+**STIPS Improvements**
+
+- PSFs generated with `webbpsf` are now PSF grids. [:pr:``, :user:`york-stsci`]
+- STIPS has the option to keep all data in memory. [:pr:``, :user:`york-stsci`]
+- 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`]
+- Travis was setup to run and pass tests. Outdated tests have been removed to allow Travis to pass. [:pr:`65`, :user:`robelgeda`]
+- Test data has been moved to a STScI box folder. [:pr:`64`, :user:`robelgeda`]
+- `dev` folder added for any developer related tools. [:pr:`69`, :user:`robelgeda`]
+- Frozen environments saved at `dev/conda_envs`. [:pr:`69`, :user:`robelgeda`]
+
+Version 1.0.7
+=============
+*2020 January 8*
+
+**STIPS Improvements**
+
+- Cookie cutter template used to create better package infrastructure. [:pr:`40`, :user:`robelgeda`]
+- Docker file added for ease of install. [:pr:`48`, :user:`robelgeda`]
+- environment.yml added for easy conda env build. [:pr:`42`, :user:`robelgeda`]
+- Read the Docs documentation established. [:pr:`55`, :user:`robelgeda`]
+- F062 filter added to Roman WFI. [:pr:`51`, :user:`york-stsci`]
+- Update STIPS to use WbbPSF 0.9.0. [:pr:`51`, :user:`york-stsci`]
+- Travis CI initiated for unit and regression testing. [:pr:`40`, :user:`robelgeda`]
+- Python version set to 3.7 [:pr:`40`, :user:`robelgeda`]
+- Licenses updated [:pr:`40`, :user:`robelgeda`]
+
+**General bug fixes and small changes**
+
+- 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`]
+- Adding WCS information to PSF files. PSF files will now have the following:
+    - RA equal to the observation RA at which they were produced
+    - DEC equal to the observation DEC at which they were produced
+    - PA equal to the observation PA at which they were produced
+    - CDELT keywords equal to the PIXELSCL keyword, but adjusted to degrees rather than arcsec.
+    - [:pr:`47`, :user:`york-stsci`]

stips-2.2.2/CITATION

@@ -0,0 +1,8 @@
+See http://journals.aas.org/authors/references.html#Software on how to
+cite software.
+
+GitHub has Zenodo DOI integration:
+https://guides.github.com/activities/citable-code/
+
+Also see https://swcarpentry.github.io/git-novice/12-citation/
+for further reading.

stips-2.2.2/CODE_OF_CONDUCT.md

@@ -0,0 +1,24 @@
+# Spacetelescope Open Source Code of Conduct
+
+We expect all "spacetelescope" organization projects to adopt a code of conduct that ensures a productive, respectful environment for all open source contributors and participants. We are committed to providing a strong and enforced code of conduct and expect everyone in our community to follow these guidelines when interacting with others in all forums. Our goal is to keep ours a positive, inclusive, successful, and growing community. The community of participants in open source Astronomy projects is made up of members from around the globe with a diverse set of skills, personalities, and experiences. It is through these differences that our community experiences success and continued growth. 
+
+
+As members of the community,
+
+- We pledge to treat all people with respect and provide a harassment- and bullying-free environment, regardless of sex, sexual orientation and/or gender identity, disability, physical appearance, body size, race, nationality, ethnicity, and religion. In particular, sexual language and imagery, sexist, racist, or otherwise exclusionary jokes are not appropriate.
+
+- We pledge to respect the work of others by recognizing acknowledgment/citation requests of original authors. As authors, we pledge to be explicit about how we want our own work to be cited or acknowledged.
+
+- We pledge to welcome those interested in joining the community, and realize that including people with a variety of opinions and backgrounds will only serve to enrich our community. In particular, discussions relating to pros/cons of various technologies, programming languages, and so on are welcome, but these should be done with respect, taking proactive measure to ensure that all participants are heard and feel confident that they can freely express their opinions.
+
+- We pledge to welcome questions and answer them respectfully, paying particular attention to those new to the community. We pledge to provide respectful criticisms and feedback in forums, especially in discussion threads resulting from code contributions.
+
+- We pledge to be conscientious of the perceptions of the wider community and to respond to criticism respectfully. We will strive to model behaviors that encourage productive debate and disagreement, both within our community and where we are criticized. We will treat those outside our community with the same respect as people within our community.
+
+- We pledge to help the entire community follow the code of conduct, and to not remain silent when we see violations of the code of conduct. We will take action when members of our community violate this code such as such as contacting conduct@stsci.edu (all emails sent to this address will be treated with the strictest confidence) or talking privately with the person.
+
+This code of conduct applies to all community situations online and offline, including mailing lists, forums, social media, conferences, meetings, associated social events, and one-to-one interactions.
+
+Parts of this code of conduct have been adapted from the Astropy and Numfocus codes of conduct.
+http://www.astropy.org/code_of_conduct.html
+https://www.numfocus.org/about/code-of-conduct/

stips-2.2.2/CONTRIBUTING.md

@@ -0,0 +1,5 @@
+Please open a new issue or new pull request for bugs, feedback, or new features you would like to see. If there is an issue you would like to work on, please leave a comment and we will be happy to assist. New contributions and contributors are very welcome!
+
+New to github or open source projects? If you are unsure about where to start or haven't used github before, please feel free to contact the package maintainers. 
+
+Feedback and feature requests? Is there something missing you would like to see? Please open an issue or send an email to the maintainers. This package follows the Spacetelescope [Code of Conduct](CODE_OF_CONDUCT.md)  strives to provide a welcoming community to all of our users and contributors.

stips-2.2.2/Dockerfile

@@ -0,0 +1,32 @@
+FROM continuumio/miniconda3
+MAINTAINER Space Telescope Science Institute <help@stsci.edu>
+
+#########
+# Setup #
+#########
+
+ENV HOME /root
+WORKDIR $HOME
+
+# Clone STScI-STIPS
+RUN git clone https://github.com/spacetelescope/STScI-STIPS.git
+ENV STIPSDIR $HOME/STScI-STIPS
+
+##########################
+# Basic apt Requirements #
+##########################
+
+WORKDIR $STIPSDIR
+
+RUN conda env create -f environment.yml
+RUN echo "conda activate stips" >> ~/.bashrc
+SHELL ["/bin/bash", "--login", "-c"]
+
+##################
+# Reference Data #
+##################
+
+WORKDIR $HOME
+
+RUN echo -e "import stips\nstips.DownloadReferenceData()" >> activate_stips.py
+RUN python activate_stips.py

stips-2.2.2/MANIFEST.in

@@ -0,0 +1,22 @@
+include *
+recursive-include * *
+exclude *.pyc *.pyo
+
+include README.rst
+include CHANGES.rst
+
+include setup.cfg
+include stips/tests/coveragerc
+
+recursive-include stips *.pyx *.c *.pxd
+recursive-include docs *
+recursive-include licenses *
+recursive-include cextern *
+recursive-include scripts *
+
+prune build
+prune docs/_build
+prune docs/api
+prune dist
+
+global-exclude *.pyc *.o

stips-2.2.2/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.1
+Name: stips
+Version: 2.2.2
+Summary: STIPS is the Space Telescope Imaging Product Simulator.
+Home-page: https://github.com/spacetelescope/STScI-STIPS
+Author: Space Telescope Science Institute
+Author-email: york@stsci.edu
+License: BSD 3-Clause
+Requires-Dist: astropy
+Requires-Dist: numpy
+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: montage-wrapper
+Requires-Dist: pyyaml
+Requires-Dist: soc_roman_tools
+
+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.

stips-2.2.2/README.md

@@ -0,0 +1,45 @@
+# 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
+
+## Table of Contents
+
+* [Overview](#overview)
+* [Why use STIPS?](#why-use-stips)
+
+## 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
+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
+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
+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
+high-accuracy observations.
+
+Developed by Brian York ([@york-stsci](https://github.com/york-stsci)),
+Robel Geda ([@robelgeda](https://github.com/robelgeda)), and
+O. Justin Otor ([@ojustino](https://github.com/ojustino)).
+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)).
+
+![Alt text](docs/roman_figures/stips_demo.png?raw=true "Roman WFI Image of a Star Cluster and Background Galaxies")
+