The James Webb Space Telescope Quicklook Application
JWQL
)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:
Official API documentation can be found on ReadTheDocs
The jwql
application is available at https://jwql.stsci.edu. Please note that the application is currently restricted to specific JWST instrument team members.
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:
conda
environmentIt is highly suggested that contributors have a working installation of anaconda
or miniconda
for Python 3.9+. 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 pyproject.toml
file included in the repository.
jwql
repoYou 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 [email protected]: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, if necessary, install conda
. Next, 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
Note: If you have added a step activating conda to your default terminal/shell (e.g. the .bashrc
, .zshrc
, or .profile
file) then you don't need to do the above step.
Lastly, create the jwql
environment via one of the environment.yml
files (currently environment_python_3.9.yml
, for python 3.9, and environment_python_3.10.yml
, for python 3.10, are supported by jwql
):
conda env create -f environment_python_3.9.yml
or
conda env create -f environment_python_3.10.yml
Much of the jwql
software depends on the existence of a config.json
file within the jwql
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.
If you use JWQL
for work/research presented in a publication (whether directly,
or as a dependency to another package), we recommend and encourage the following acknowledgment:
This research made use of the open source Python package 'jwql' (Bourque et al, 2020).
where (Bourque et al, 2020) is a citation of the Zenodo record available using the DOI badge above. By using the Export
box in the lower right corner of the Zenodo page, you can export the citation in the format most convenient for you.
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:
spacetelescope
jwql
repository.upstream
properly.origin
).spacetelescope
jwql
repository, create a pull request that merges the branch into spacetelescope:develop
.Users who wish to report an issue or request a new feature may do so through the following channels:
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 [email protected]
.
Any questions about the jwql
project or its software can be directed to [email protected]
.