Package: jwst-coronagraph-visibility
jwst_coronagraph_visibility: James Webb Space Telescope Coronagraph Visibility ToolSIAF version:PRDOPSSOC-027TheJamesWebbSpaceTelescopeCoronagraph VisibilityTool (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 atJWST Coronagraph Visibility Tool Help.Authors:Christopher Stark, Joseph Long, J. Brendan Hagan, Mees Fix and Bryony NicksonInstallation for UsersInstalling the Python PackageInstalling with pipCVT may be installed from thePython Package Indexin the usual manner for Python packages.$ pip install jwst_coronagraph_visibilityInstalling the macOS applicationIf 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 ContributorsFor those wishing to contribute to the code base, you can installjwst_coronagraph_visibilityby cloning and
installing the repository. This is only recommended for those looking to help with development. In general, those
wishing only to use the jwst_coronagraph_visibility tool should install the latest stable version from using Astroconda,
as described in theinstructions above.PrerequisitesIt is highly recommended that contributors have a working installation ofMinicondaorAnacondafor Python 3.6. Package requirements for contributing tojwst_coronagraph_visibilitywill be
provided by asetup.pyscript included in the repository.Clone the repository:Clone thejwst_coronagraph_visibilityGitHub repository as follows:$ git clone https://github.com/brynickson/jwst_coronagraph_visibility.git
$ cd jwst_coronagraph_visibilityEnvironment InstallationFollowing the download of thejwst_coronagraph_visibilityrepository, create and activate a newjwst_coronagraph_visibilityenvironment:$ conda create -n jwst_coronagraph_visibility-3.7 python=3.7
$ conda activate jwst_coronagraph_visibility-3.7Package installationNext, you need to install thejwst_coronagraph_visibilitypackage. This can be accomplished by running thesetup.pyscript:(jwst_coronagraph_visibility-3.7)$ python setup.py developThe package should now appear if you runconda list jwst_coronagraph_visibility.CitationIf 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 inCITATION.Software ContributionsContributors should use a"forking workflow"when making contributions to the project.Code of ConductUsers and contributors to thejwst_coronagraph_visibilityrepository should adhere to theCode of Conduct. Any issues or violations pertaining to the Code of Conduct should be brought to
the attention of ajwst_coronagraph_visibilityteam member or toconduct@stsci.edu.QuestionsFor any questions about thejwst_coronagraph_visibilityproject or its software or documentation, pleaseopen an Issue.Known IssuesThe 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 athttps://github.com/spacetelescope/jwst_coronagraph_visibility/issues.Current Development TeamMees Fix@mfixstsciBryony Nickson@brynicksonAcronyms[1]- Mid-Infrared Instrument (seedocumentation)↩[2]- Near-Infrared Instrument (seedocumentation)↩[3]- Astronomer's Proposal Tool (seedocumentation)↩