Documentation for visitparser¶
visitparser
provides tools for parsing information from JWST visit files.
visitparser Documentation¶
Tools for parsing information from JWST visit files.
Functionalities¶
Read JWST .vst files
Return Visit object that contains all parsed information from the .vst file, i.e. ID, groups, sequences, activities
Produce summaries of activities in tabular format
Support for producing reports in text format
Where to Find visitparser¶
visitparser is hosted and developed at https://github.com/spacetelescope/jwst-visit-parser
Installation¶
This package is being developed in a python 3.5 environment.
How to install¶
visitparser is available via astroconda:
`conda install jwst-visit-parser`
Alternatively, you can clone the repository:
`git clone https://github.com/spacetelescope/jwst-dms-edb`
and install visitparser like this:
`cd visitparser`
`python setup.py install`
or:
`pip install .`
User Documentation¶
Example usage:
Reporting Issues / Contributing¶
Do you have feedback and feature requests? Is there something missing you would like to see? Please open a new issue or new pull request at https://github.com/spacetelescope/jwst-visit-parser 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! This package follows the STScI Code of Conduct strives to provide a welcoming community to all of our users and contributors.
We strive to adhere to the STScI Style Guides.
Please see the guidelines for jwql
: https://github.com/spacetelescope/jwql
Reference API¶
parser¶
Module to inspect JWST visit files.
Authors¶
Johannes Sahlmann Marshall Perrin
-
class
visitparser.parser.
Activity
(cmdstring, *args, **kwargs)[source]¶ Capture information related to activity.
-
class
visitparser.parser.
Aux
(cmdstring, verbose=False)[source]¶ Capture statement identified by AUX keyword.
-
class
visitparser.parser.
Dither
(cmdstring, verbose=False)[source]¶ Capture statement identified by DITHER keyword.
-
class
visitparser.parser.
Guide
(cmdstring, group=None, sequence=None, verbose=False)[source]¶ Expand Guide statement.
-
class
visitparser.parser.
Momentum
(cmdstring, verbose=False)[source]¶ Capture statement identified by MOMENTUM keyword.
-
class
visitparser.parser.
Slew
(cmdstring, group=None, sequence=None, verbose=False)[source]¶ Expand statement identified by SLEW keyword.
-
class
visitparser.parser.
SlewOrAct
(cmdstring, group=None, sequence=None, verbose=False)[source]¶ Capture statement identified by SLEW or ACT keyword.
-
property
gsa
¶ Group, sequence, activity
-
property
-
class
visitparser.parser.
Statement
(cmdstring, verbose=False)[source]¶ Capture visit file statement delimited by a semicolon.
-
class
visitparser.parser.
Visit
(templates, statements, groups)[source]¶ Class for JWST visit file information
-
class
visitparser.parser.
VisitDescription
(cmdstring, verbose=False)[source]¶ Capture statement identified by VISIT keyword.
-
visitparser.parser.
crosscheck_wfsc_visit_file
(filename)[source]¶ update Perrin’s function to updated code.
filename
-
visitparser.parser.
iswhitespace
(x)¶