{"id":15062427,"url":"https://github.com/spacetelescope/jwst_coronagraph_visibility","last_synced_at":"2025-04-10T13:33:46.361Z","repository":{"id":46221541,"uuid":"54589888","full_name":"spacetelescope/jwst_coronagraph_visibility","owner":"spacetelescope","description":"Visualize approximate pointing constraints for JWST coronagraphs.","archived":false,"fork":false,"pushed_at":"2024-07-29T18:22:24.000Z","size":12852,"stargazers_count":8,"open_issues_count":11,"forks_count":10,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-03-24T12:12:52.447Z","etag":null,"topics":["astronomy","coronagraph","jwst","simulator"],"latest_commit_sha":null,"homepage":"https://github.com/spacetelescope/jwst_visibility/blob/master/docs/index.rst","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/spacetelescope.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION","codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-03-23T20:10:56.000Z","updated_at":"2024-06-02T20:49:41.000Z","dependencies_parsed_at":"2024-10-13T01:40:54.363Z","dependency_job_id":"1a07d5d6-252e-428d-82ca-a2f975932e27","html_url":"https://github.com/spacetelescope/jwst_coronagraph_visibility","commit_stats":{"total_commits":228,"total_committers":6,"mean_commits":38.0,"dds":0.5745614035087719,"last_synced_commit":"bdd0cc19bd86b29b402df524aab634bb7b3d7992"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spacetelescope%2Fjwst_coronagraph_visibility","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spacetelescope%2Fjwst_coronagraph_visibility/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spacetelescope%2Fjwst_coronagraph_visibility/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spacetelescope%2Fjwst_coronagraph_visibility/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/spacetelescope","download_url":"https://codeload.github.com/spacetelescope/jwst_coronagraph_visibility/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248225840,"owners_count":21068078,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["astronomy","coronagraph","jwst","simulator"],"created_at":"2024-09-24T23:36:02.570Z","updated_at":"2025-04-10T13:33:46.336Z","avatar_url":"https://github.com/spacetelescope.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# jwst_coronagraph_visibility: James Webb Space Telescope Coronagraph Visibility Tool\n\n[![Current Release](https://img.shields.io/github/v/release/spacetelescope/jwst_coronagraph_visibility.svg)](https://github.com/spacetelescope/jwst_coronagraph_visibility/releases/latest/)\n[![License](https://img.shields.io/github/license/spacetelescope/jwst_coronagraph_visibility)](LICENSE)\n[![Python](https://img.shields.io/badge/Python-3.6-blue.svg)](https://www.python.org/)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4488421.svg)](https://doi.org/10.5281/zenodo.4488421)\n[![STScI](https://img.shields.io/badge/powered%20by-STScI-blue.svg?colorA=707170\u0026colorB=3e8ddd\u0026style=flat)](http://www.stsci.edu)\n**SIAF version:** PRDOPSSOC-027\n\nThe **J**ames **W**ebb **S**pace **T**elescope **Coronagraph Visibility** Tool (CVT) is a GUI-based target visibility \ntool for assessing target visibilities and available position angles versus time relative to \nMIRI\u003csup id=\"a1\"\u003e[[1]](#f1)\u003c/sup\u003e and NIRCam\u003csup id=\"a2\"\u003e[[2]](#f1)\u003c/sup\u003e coronagraphic masks. The CVT is available as \na standalone gui-based python tool (AstroConda package) or as a macOS app bundle. \n\nThe allowed pointing of JWST leads to target visibility that depends on ecliptic latitude, and the range of roll angles \nallowed depends on solar elongation. The allowed position angles for a target can thus be a complicated function of \ntime. As a result, it can be difficult to: (1) understand the possible orientations of a given target on the detector, \nespecially in relation to any instrumental obscurations; (2) determine the ideal roll angle offsets for multi-roll \nobservations; and (3) determine a group of targets that are simultaneously visible. The CVT was created to address \nthese issues and assist in planning MIRI and NIRCam programs prior to entering targets and observations into the \nAPT\u003csup id=\"a3\"\u003e[[3]](#f1)\u003c/sup\u003e. \n\nWe stress that the CVT is designed to provide quick illustrations of the possible observable orientations for a given \ntarget. As such, the CVT rapidly approximates JWST’s pointing restrictions and does not query the official JWST Proposal \nConstraint Generator (PCG), nor include detailed pointing restrictions like Earth and Moon avoidance, etc. Therefore, \nCVT results should be treated as useful approximations that may differ from official APT constraints by a degree or so.\n\nDocumentation can be found online at [JWST Coronagraph Visibility Tool Help](https://jwst-docs.stsci.edu/jwst-other-tools/jwst-target-visibility-tools/jwst-coronagraphic-visibility-tool-help).\n\n**Authors:** Christopher Stark, Joseph Long, J. Brendan Hagan, Mees Fix and Bryony Nickson\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"screenshot.png\" alt=\"Screenshot of the JWST Coronagraph Visibility Tool showing target HR 8799 with three companions plotted.\"/\u003e\n\u003c/p\u003e\n\n\u003ca name=\"user-install\"\u003e\u003c/a\u003e\n## Installation for Users \n\n### Installing the Python Package\n\n#### Installing with pip\n\nCVT may be installed from the [Python Package Index](https://pypi.org/) in the usual manner for Python packages.\n \n    $ pip install jwst_coronagraph_visibility \n\n### Installing the macOS application\n\nIf you are running macOS and would like a double-clickable application, click on the following link:\u003cbr\u003e **[Download for macOS (86.4 MB)](https://github.com/spacetelescope/jwst_coronagraph_visibility/releases/download/0.4.4/jwst_coronagraph_visibility_tool_macos.zip)**. \n\nSimply extract the downloaded zip file to obtain the .app bundle, then double-click to run the JWST Coronagraph Visibility Tool.\n\n## Installation for Contributors\n\nFor those wishing to contribute to the code base, you can install `jwst_coronagraph_visibility` by cloning and \ninstalling the repository. This is only recommended for those looking to help with development. In general, those \nwishing only to use the jwst_coronagraph_visibility tool should install the latest stable version from using Astroconda, \nas described in the [instructions above](#user-install).\n\n### Prerequisites \n\nIt is highly recommended that contributors have a working installation of [Miniconda](https://conda.io/miniconda.html) \nor [Anaconda](Anaconda) for Python 3.6. Package requirements for contributing to `jwst_coronagraph_visibility` will be \nprovided by a `setup.py` script included in the repository. \n\n### Clone the repository:\n\nClone the `jwst_coronagraph_visibility` GitHub repository as follows:\n\n    $ git clone https://github.com/brynickson/jwst_coronagraph_visibility.git\n    $ cd jwst_coronagraph_visibility\n\n### Environment Installation \n\nFollowing the download of the `jwst_coronagraph_visibility` repository, create and activate a new \n`jwst_coronagraph_visibility` environment:\n\n    $ conda create -n jwst_coronagraph_visibility-3.7 python=3.7\n    $ conda activate jwst_coronagraph_visibility-3.7\n    \n### Package installation\n\nNext, you need to install the `jwst_coronagraph_visibility` package. This can be accomplished by running the `setup.py` \nscript:\n\n    (jwst_coronagraph_visibility-3.7)$ python setup.py develop\n    \nThe package should now appear if you run `conda list jwst_coronagraph_visibility`. \n\n\n## Citation \n\nIf you use the CVT for work/research presented in a publication (whether directly, or as a dependency to another \npackage), please consider citing the Zenodo record using the DOI page above. Please find additional instructions in \n[CITATION](CITATION).\n\n\n## Software Contributions\n\nContributors should use a [\"forking workflow\"](https://github.com/spacetelescope/style-guides/blob/master/guides/git-workflow.md#the-forking-workflow-) \nwhen making contributions to the project. \n\n## Code of Conduct \n\nUsers and contributors to the `jwst_coronagraph_visibility` repository should adhere to the \n[Code of Conduct](CODE_OF_CONDUCT). Any issues or violations pertaining to the Code of Conduct should be brought to \nthe attention of a `jwst_coronagraph_visibility` team member or to `conduct@stsci.edu`.\n\n## Questions\n\nFor any questions about the `jwst_coronagraph_visibility` project or its software or documentation, please \n[open an Issue](https://github.com/spacetelescope/jwst_coronagraph_visibility/issues).\n\n## Known Issues\n\n  * 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.\n  * Target name resolution depends on the availability of the SIMBAD service. If the service cannot be reached, you will have to enter coordinates yourself.\n  * 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.\n  * 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.\n\n*See issue tracker at* https://github.com/spacetelescope/jwst_coronagraph_visibility/issues.\n\n## Current Development Team\n- Mees Fix [@mfixstsci](https://github.com/mfixstsci)\n- Bryony Nickson [@brynickson](https://github.com/brynickson)\n\u003cbr\u003e\n\n##  Acronyms \n\u003cb id=\"f1\"\u003e[1]\u003c/b\u003e - Mid-Infrared Instrument (see [documentation](https://jwst-docs.stsci.edu/mid-infrared-instrument/miri-observing-modes/miri-coronagraphic-imaging)) [ ↩](#a1) \u003cbr\u003e\n\u003cb id=\"f1\"\u003e[2]\u003c/b\u003e - Near-Infrared Instrument (see [documentation](https://jwst-docs.stsci.edu/near-infrared-camera/nircam-observing-modes/nircam-coronagraphic-imaging)) [ ↩](#a2) \u003cbr\u003e\n\u003cb id=\"f1\"\u003e[3]\u003c/b\u003e - Astronomer's Proposal Tool (see [documentation](https://jwst-docs.stsci.edu/jwst-astronomers-proposal-tool-overview)) [ ↩](#a2)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspacetelescope%2Fjwst_coronagraph_visibility","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspacetelescope%2Fjwst_coronagraph_visibility","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspacetelescope%2Fjwst_coronagraph_visibility/lists"}