Data

Tools

Indexes

Applications

Experiments

Open Source Science

jwst-coronagraph-visibility

Visualize approximate pointing constraints for JWST coronagraphs.

https://github.com/spacetelescope/jwst_coronagraph_visibility

Science Score: 72.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
  • ✓
    DOI references
    Found 3 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ✓
    Committers with academic emails
    4 of 6 committers (66.7%) from academic institutions
  • ✓
    Institutional organization owner
    Organization spacetelescope has institutional domain (www.stsci.edu)
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.8%) to scientific vocabulary

Keywords

astronomy coronagraph jwst simulator
Last synced: 6 months ago · JSON representation ·

Repository

Visualize approximate pointing constraints for JWST coronagraphs.

Basic Info
Statistics
  • Stars: 8
  • Watchers: 13
  • Forks: 10
  • Open Issues: 11
  • Releases: 11
Topics
astronomy coronagraph jwst simulator
Created almost 10 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog License Code of conduct Citation Codeowners

README.md

jwstcoronagraphvisibility: James Webb Space Telescope Coronagraph Visibility Tool

Current Release License Python DOI STScI SIAF version: PRDOPSSOC-027

The James Webb Space Telescope Coronagraph Visibility Tool (CVT) is a GUI-based target visibility tool for assessing target visibilities and available position angles versus time relative to MIRI[1] and NIRCam[2] coronagraphic masks. The CVT is available as a standalone gui-based python tool (AstroConda package) or as a macOS app bundle.

The allowed pointing of JWST leads to target visibility that depends on ecliptic latitude, and the range of roll angles allowed depends on solar elongation. The allowed position angles for a target can thus be a complicated function of time. As a result, it can be difficult to: (1) understand the possible orientations of a given target on the detector, especially in relation to any instrumental obscurations; (2) determine the ideal roll angle offsets for multi-roll observations; and (3) determine a group of targets that are simultaneously visible. The CVT was created to address these issues and assist in planning MIRI and NIRCam programs prior to entering targets and observations into the APT[3].

We stress that the CVT is designed to provide quick illustrations of the possible observable orientations for a given target. As such, the CVT rapidly approximates JWST’s pointing restrictions and does not query the official JWST Proposal Constraint Generator (PCG), nor include detailed pointing restrictions like Earth and Moon avoidance, etc. Therefore, CVT results should be treated as useful approximations that may differ from official APT constraints by a degree or so.

Documentation can be found online at JWST Coronagraph Visibility Tool Help.

Authors: Christopher Stark, Joseph Long, J. Brendan Hagan, Mees Fix and Bryony Nickson

Screenshot of the JWST Coronagraph Visibility Tool showing target HR 8799 with three companions plotted.

Installation for Users

Installing the Python Package

Installing with pip

CVT may be installed from the Python Package Index in the usual manner for Python packages.

$ pip install jwst_coronagraph_visibility

Installing the macOS application

If you are running macOS and would like a double-clickable application, click on the following link:
Download for macOS (86.4 MB).

Simply extract the downloaded zip file to obtain the .app bundle, then double-click to run the JWST Coronagraph Visibility Tool.

Installation for Contributors

For those wishing to contribute to the code base, you can install jwst_coronagraph_visibility by cloning and installing the repository. This is only recommended for those looking to help with development. In general, those wishing only to use the jwstcoronagraphvisibility tool should install the latest stable version from using Astroconda, as described in the instructions above.

Prerequisites

It is highly recommended that contributors have a working installation of Miniconda or Anaconda for Python 3.6. Package requirements for contributing to jwst_coronagraph_visibility will be provided by a setup.py script included in the repository.

Clone the repository:

Clone the jwst_coronagraph_visibility GitHub repository as follows:

$ git clone https://github.com/brynickson/jwst_coronagraph_visibility.git
$ cd jwst_coronagraph_visibility

Environment Installation

Following the download of the jwst_coronagraph_visibility repository, create and activate a new jwst_coronagraph_visibility environment:

$ conda create -n jwst_coronagraph_visibility-3.7 python=3.7
$ conda activate jwst_coronagraph_visibility-3.7

Package installation

Next, you need to install the jwst_coronagraph_visibility package. This can be accomplished by running the setup.py script:

(jwst_coronagraph_visibility-3.7)$ python setup.py develop

The package should now appear if you run conda list jwst_coronagraph_visibility.

Citation

If you use the CVT for work/research presented in a publication (whether directly, or as a dependency to another package), please consider citing the Zenodo record using the DOI page above. Please find additional instructions in CITATION.

Software Contributions

Contributors should use a "forking workflow" when making contributions to the project.

Code of Conduct

Users and contributors to the jwst_coronagraph_visibility repository should adhere to the Code of Conduct. Any issues or violations pertaining to the Code of Conduct should be brought to the attention of a jwst_coronagraph_visibility team member or to conduct@stsci.edu.

Questions

For any questions about the jwst_coronagraph_visibility project or its software or documentation, please open an Issue.

Known Issues

  • The CVT does not (and will not) query the JWST Proposal Constraint Generator. The only constraint on the field of regard is the Sun and anti-Sun avoidance angle.
  • Target name resolution depends on the availability of the SIMBAD service. If the service cannot be reached, you will have to enter coordinates yourself.
  • The CVT does not currently provide a way to export the plotted points as text. Plots can be saved from the GUI using the save icon below the plot panel.
  • The CVT has only been tested on Mac and Linux. Issue reports from Windows users are welcome, and we will do our best to address them, but we are not testing the tool on Windows.

See issue tracker at https://github.com/spacetelescope/jwstcoronagraphvisibility/issues.

Current Development Team

Acronyms

[1] - Mid-Infrared Instrument (see documentation) ↩
[2] - Near-Infrared Instrument (see documentation) ↩
[3] - Astronomer's Proposal Tool (see documentation) ↩

Owner

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

STScI is operated by AURA for NASA

Citation (CITATION) 

If you use jwst_coronagraph_visibility for work/research presented in a publication (whether
directly, or as a dependency to another package), we recommend and encourage
the following acknowledgment:

  This research made use of the open source Python package jwst_coronagraph_visibility, 
  the JWST Coronagraph Visibility tool (Stark et al. 2021)
    
The recommended BibTeX entry for the above citation is:

@software{chris_stark_2021_4488421,
  author       = {Chris Stark and
                  Joseph Long and
                  Brendan Hagan and
                  Mees Fix and
                  Bryony Nickson},
  title        = {spacetelescope/jwst_coronagraph_visibility: Tier 2 JWST Community Software Standards},
  month        = feb,
  year         = 2021,
  publisher    = {Zenodo},
  version      = {0.4.4},
  doi          = {10.5281/zenodo.4488421},
  url          = {https://doi.org/10.5281/zenodo.4488421}
}

GitHub Events

Total
Last Year

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 228
  • Total Committers: 6
  • Avg Commits per committer: 38.0
  • Development Distribution Score (DDS): 0.575
Top Committers
Name Email Commits
Joseph Long j****g@s****u 97
Brendan Hagan h****n@s****u 75
Mees Fix m****x@s****u 28
Joseph Long j****l@f****m 14
Bryony Nickson b****n@s****u 13
pyup-bot g****t@p****o 1
Committer Domains (Top 20 + Academic)
stsci.edu: 4 pyup.io: 1 fastmail.com: 1

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 24
  • Total pull requests: 29
  • Average time to close issues: 6 months
  • Average time to close pull requests: about 1 month
  • Total issue authors: 10
  • Total pull request authors: 9
  • Average comments per issue: 1.75
  • Average comments per pull request: 0.59
  • Merged pull requests: 20
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • josePhoenix (8)
  • mperrin (5)
  • mfixstsci (2)
  • jbhagan (2)
  • pyup-bot (2)
  • abhijithrajan (1)
  • pllim (1)
  • njcuk9999 (1)
  • nluetzge (1)
  • migueldvb (1)
Pull Request Authors
  • jbhagan (13)
  • brynickson (4)
  • mfixstsci (4)
  • josePhoenix (3)
  • pllim (2)
  • mperrin (1)
  • jordan-stone (1)
  • juliengirard (1)
  • pyup-bot (1)
Top Labels
Issue Labels
enhancement (4) wontfix (2) bug (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 25 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 8
  • Total maintainers: 4
pypi.org: jwst-coronagraph-visibility

JWST coronagraphic target observability calculator

  • Versions: 8
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 25 Last month
Rankings
Dependent packages count: 10.0%
Forks count: 10.9%
Average: 18.6%
Stargazers count: 19.3%
Dependent repos count: 21.7%
Downloads: 31.1%
Maintainers (4)
mees.fix stsci_maintainer mperrin bnickson
Last synced: 6 months ago

Dependencies

requirements.txt pypi
  • matplotlib >=3.1.3
  • numpy >=1.17.5
  • pysiaf >=0.7.1
  • requests >=2.8.1
setup.py pypi
  • matplotlib >=3.1.3
  • numpy >=1.17.5
  • pysiaf >=0.7.1
  • requests >=2.8.1
.github/workflows/ci.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/publish-to-pypi.yml actions