The JWST Quicklook Application (JWQL) is a database-driven web application and automation framework for use by the JWST instrument teams to monitor and trend the health, stability, and performance of the JWST instruments. The system is comprised of the following:
- 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)
- A relational database that stores observational metadata allowing for data discovery via relational queries (MAST database API).
- A software library that provides tools to support an automation framework in which to build automated instrument monitoring routines.
- A web application that allows users to visually inspect new and archival JWST data as well as instrument-specific monitoring and performance results.
Official API documentation can be found on ReadTheDocs
The jwql application is currently under heavy development. The 1.0 release is expected in 2019. Currently, a development version of the web application can be found at https://dljwql.stsci.edu.
To install jwql, simply use pip:
pip install jwql
The section below describes a more detailed installation for users that wish to contribute to the jwql repository.
Getting jwql up and running on your own computer requires four steps, detailed below:
- Cloning the GitHub repository
- Installing the
condaenvironment - Installing the python package
- Setting up the configuration file
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:
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.
You first need to clone 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 repository there. Once you are in the directory you can do the following:
git clone https://github.com/spacetelescope/jwql.git
cd jwql
or, if you would rather use SSH instead of https, type
git clone git@github.com:spacetelescope/jwql.git
cd jwql
instead, and then proceed as stated.
Following the download of the jwql repository, contributors can then install the jwql conda environment via the environment yaml file, which contains all of the dependencies for the project. First, ensure that your version of conda is up to date:
conda update conda
Next, activate the base or root environment (depending on your version of conda):
source activate base/root
Lastly, create the jwql environment via the environment_python_3_6.yml file:
conda env create -f environment_python_3_6.yml --name jwql-3.6
Next, you need to install the jwql package under development mode. This can be accomplished either by running the setup.py script, or pip install with the -e option:
python setup.py develop
or
pip install -e .
The package should now appear if you run conda list jwql.
Much of the jwql software depends on the existence of a config.json file within the utils directory. This file contains data that may be unique to users and/or contain sensitive information. Please see the Config File wiki page for instructions on how to provide this file.
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.
Contributors are also encouraged to check out the Checklist for Contributors Guide to ensure the pull request contains all of the necessary changes.
The following is a bare-bones example of a best work flow for contributing to the project:
- Create a fork off of the
spacetelescopejwqlrepository. - Make a local clone of your fork.
- Ensure your personal fork is pointing
upstreamproperly. - Create a branch on that personal fork.
- Make your software changes.
- Push that branch to your personal GitHub repository (i.e.
origin). - On the
spacetelescopejwqlrepository, create a pull request that merges the branch intospacetelescope:develop. - Assign a reviewer from the team for the pull request.
- Iterate with the reviewer over any needed changes until the reviewer accepts and merges your branch.
- Delete your local copy of your branch.
Users who wish to report an issue or request a new feature may do so through the following channels:
- Submit a new issue on GitHub (preferred method): https://github.com/spacetelescope/jwql/issues
- Submit a new ticket on Jira: https://jira.stsci.edu/projects/JWQL/
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.
Any questions about the jwql project or its software can be directed to jwql@stsci.edu.
- Matthew Bourque (INS) @bourque
- Misty Cracraft (INS) @cracraft
- Mike Engesser (INS) @mengesser
- Mees Fix (INS) @mfixstsci
- Bryan Hilbert (INS) @bilhbert4
- Graham Kanarek (INS) @gkanarek
- Teagan King (INS) @tnking97
- Maria Pena-Guerrero @penaguerrero
- Ben Sunnquist (INS) @bsunnquist
- Lauren Chambers (INS) @laurenmarietta
- Joe Filippazzo (INS) @hover2pi
- Sara Ogaz (DMD) @SaOgaz
- Catherine Martlin (INS) @catherine-martlin
- Johannes Sahlmann (INS) @Johannes-Sahlmann
- Faith Abney (DMD)
- Joshua Alexander (DMD) @obviousrebel
- Anastasia Alexov (DMD)
- Sara Anderson (DMD)
- Tracy Beck (INS)
- Francesca Boffi (INS) @frboffi
- Clara Brasseur (DMD) @ceb8
- Matthew Burger (DMD)
- Steven Crawford (DMD) @stscicrawford
- James Davies (DMD) @jdavies-st
- Rosa Diaz (INS) @rizeladiaz
- Van Dixon (INS)
- Tom Donaldson (DMD) @tomdonaldson
- Kim DuPrie (DMD)
- Jonathan Eisenhamer (DMD) @stscieisenhamer
- Ann Feild (OPO)
- Mike Fox (DSMO) @mfox22
- Scott Friedman (INS)
- Alex Fullerton (INS) @awfullerton
- Lisa Gardner (DMD)
- Vera Gibbs (ITSD)
- Catherine Gosmeyer (INS) @cgosmeyer
- Phil Grant (ITSD)
- Dean Hines (INS)
- Sherie Holfeltz (INS) @stholfeltz
- Joe Hunkeler (DMD) @jhunkeler
- Catherine Kaleida (DMD) @ckaleida
- Jenn Kotler (DMD) @jenneh
- Daniel Kühbacher (Goddard) @DanielKuebi
- Mark Kyprianou (DMD) @mkyp
- Karen Levay (DMD)
- Crystal Mannfolk (SCOPE) @cmannfolk
- Greg Masci (ITSD)
- Jacob Matuskey (DMD) @jmatuskey
- Margaret Meixner (INS)
- Christain Mesh (DMD) @cam72cam
- Prem Mishra (ITSD)
- Don Mueller (ITSD)
- Maria Antonia Nieto-Santisteban (SEITO)
- Brian O'Sullivan (INS)
- Joe Pollizzi (JWSTMO)
- Lee Quick (DMD)
- Anupinder Rai (ITSD)
- Matt Rendina (DMD) @rendinam
- Massimo Robberto (INS) @mrobberto
- Mary Romelfanger (DMD)
- Bernie Shiao (DMD)
- 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 (DMD)
- Lara Wilkinson (OPO)
- Alex Yermolaev (ITSD) @alexyermolaev
- Joe Zahn (ITSD)