The James Webb Quicklook Application (JWQL)

The James Webb Quicklook Application (JWQL) is a database-driven web application and automation framework for use by the JWST instrument teams to monitor the health and stability of the JWST instruments. The system is comprised of the following:

1. A network file system that stores all uncalibrated and calibrated data products on disk in a centrally-located area, accessible to instrument team members (MAST data cache)
2. A relational database that stores observational metadata allowing for data discovery via relational queries (MAST database API).
3. A software library that provides tools to support an automation framework in which to build automated instrument monitoring tasks.
4. A web application that allows users to visually inspect new and archival JWST data as well as instrument-specific monitoring and calibration results.

The jwql application is currently under heavy development. The 1.0 release is expected in 2019.

Prerequisites

It is highly suggested that contributors have a working installation of anaconda or miniconda for Python 3.6. Downloads and installation instructions are available here:

• Miniconda
• Anaconda

Requirements for contributing to the jwql package will be included in the jwql conda environment, which is included in our installation instructions below. Further package requirements will be provided for jwql by a setup.py script included in the repository.

Package Installation

You first need to install the current version of jwql. The simplest way to do this is to go to the directory you want your copy of the repository to be in and clone the repoistory there. Once you are in the directory you can do the following:

git clone https://github.com/spacetelescope/jwql.git
cd jwql
python setup.py develop

or, if you would rather use SSH instead of https, type

git clone git@github.com:spacetelescope/jwql.git
cd jwql
python setup.py develop

instead, and then proceed as stated.

Environment Installation

Following the download of the jwql package, contributors can then install the jwql conda environment via the environment.yml file, which contains all of the dependencies for the project. First, one should ensure that their version of conda is up to date:

conda update conda

Next, one should activate the base environment:

source activate base

Lastly, one can create the jwql environment via the environment.yml file:

conda env create -f environment.yml

Contributing

There are two current pages to review before you begin contributing to the jwql development. The first is our style guide and the second is our suggested git workflow page, which contains an in-depth explanation of the workflow.

The following is a bare bones example of a best work flow for contributing to the project:

1. Create a fork off of the spacetelescope jwql repository.
2. Make a local clone of your fork.
3. Ensure your personal fork is pointing upstream properly.
4. Create a branch on that personal fork.
5. Make your software changes.
6. Push that branch to your personal GitHub repository (i.e. origin).
7. On the spacetelescope jwql repository, create a pull request that merges the branch into spacetelescope:master.
8. Assign a reviewer from the team for the pull request.
9. Iterate with the reviewer over any needed changes until the reviewer accepts and merges your branch.
10. Delete your local copy of your branch.

Code of Conduct

Users and contributors to the jwql 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 jwql team member or to jwql@stsci.edu.

Questions

Any questions about the jwql project or its software can be directed to jwql@stsci.edu.

Current Development Team

• Matthew Bourque (INS) @bourque
• Lauren Chambers (INS) @laurenmarietta
• Misty Cracraft (INS) @cracraft
• Joe Filippazzo (INS) @hover2pi
• Bryan Hilbert (INS) @bilhbert4
• Graham Kanarek (INS) @gkanarek
• Catherine Martlin (INS) @catherine-martlin
• Sara Ogaz (OED) @SaOgaz
• Johannes Sahlmann (INS) @Johannes-Sahlmann

Acknowledgments:

• Faith Abney (OED)
• Anastasia Alexov (OED)
• Sara Anderson (OED)
• Tracy Beck (INS)
• Francesca Boffi (INS) @frboffi
• Clara Brasseur (OED) @ceb8
• Matthew Burger (OED)
• Steven Crawford (OED) @stscicrawford
• James Davies (OED) @jdavies-st
• Rosa Diaz (INS) @rizeladiaz
• Van Dixon (INS)
• Tom Donaldson (OED) @tomdonaldson
• Mike Fox (DSMO) @mfox22
• Scott Friedman (INS)
• Alex Fullerton (INS) @awfullerton
• Lisa Gardner (OED)
• Vera Gibbs (ITSD)
• Catherine Gosmeyer (INS) @cgosmeyer
• Phil Grant (ITSD)
• Dean Hines (INS)
• Sherie Holfeltz (INS) @stholfeltz
• Joe Hunkeler (OED) @jhunkeler
• Catherine Kaleida (OED)
• Mark Kyprianou (OED) @mkyp
• Karen Levay (OED)
• Crystal Mannfolk (OED) @cmannfolk
• Greg Masci (ITSD)
• Margaret Meixner (INS)
• Prem Mishra (ITSD)
• Don Mueller (ITSD)
• Maria Antonia Nieto-Santisteban (OED)
• Joe Pollizzi (JWSTMO)
• Lee Quick (OED)
• Anupinder Rai (ITSD)
• Matt Rendina (OED) @rendinam
• Massimo Robberto (INS) @mrobberto
• Mary Romelfanger (OED)
• Bernie Shiao (OED)
• Matthew Sienkiewicz (ITSD)
• Arfon Smith (DSMO) @arfon
• Linda Smith (INS)
• Patrick Taylor (ITSD)
• Dave Unger (ITSD)
• Jeff Valenti (JWSTMO) @JeffValenti
• Thomas Walker (ITSD)
• Geoff Wallace (OED)
• Lara Wilkinson (OPO)
• Joe Zahn (ITSD)