Package: jwql
The JWST 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:A network file system that stores all uncalibrated and calibrated data products on disk in a centrally-located area, accessible to instrument team members (i.e. the 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 onReadTheDocsThejwqlapplication is available athttps://jwql.stsci.edu.  Please note that the application is currently restricted to specific JWST instrument team members.Installation for UsersTo installjwql, simply usepip:pip install jwqlThe section below describes a more detailed installation for users that wish to contribute to thejwqlrepository.Installation for ContributorsGettingjwqlup and running on your own computer requires four steps, detailed below:Cloning the GitHub repositoryInstalling thecondaenvironmentInstalling the python packageSetting up the configuration filePrerequisitesIt is highly suggested that contributors have a working installation ofanacondaorminicondafor Python 3.9+.  Downloads and installation instructions are  available here:MinicondaAnacondaRequirements for contributing to thejwqlpackage will be included in thejwqlcondaenvironment, which is included in our installation instructions below. Further package requirements will be provided forjwqlby apyproject.tomlfile included in the repository.Clone thejwqlrepoYou first need to clone the current version ofjwql. 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 jwqlor, if you would rather useSSHinstead ofhttps, typegit clone git@github.com:spacetelescope/jwql.git
cd jwqlinstead, and then proceed as stated.Environment InstallationFollowing the download of thejwqlrepository, contributors can then install thejwqlcondaenvironment via the environment yaml file, which contains all of the dependencies for the project. First, if necessary,installconda. Next, ensure that your version ofcondais up to date:conda update condaNext, activate thebaseorrootenvironment (depending on your version ofconda):source activate base/rootNote:If you have added a step activating conda to your default terminal/shell (e.g. the.bashrc,.zshrc, or.profilefile) then you don't need to do the above step.Lastly, create thejwqlenvironment via one of theenvironment.ymlfiles (currentlyenvironment_python_3.9.yml, for python 3.9, andenvironment_python_3.10.yml, for python 3.10, are supported byjwql):conda env create -f environment_python_3.9.ymlorconda env create -f environment_python_3.10.ymlConfiguration FileMuch of thejwqlsoftware depends on the existence of aconfig.jsonfile within thejwqldirectory.  This file contains data that may be unique to users and/or contain sensitive information.  Please see theConfig File wiki pagefor instructions on how to provide this file.CitationIf you useJWQLfor 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 theExportbox in the lower right corner of the Zenodo page, you can export the citation in the format most convenient for you.Software ContributionsThere are two current pages to review before you begin contributing to thejwqldevelopment. The first is ourstyle guideand the second is oursuggested git workflow page, which contains an in-depth explanation of the workflow.Contributors are also encouraged to check out theChecklist for Contributors Guideto 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 thespacetelescopejwqlrepository.Make a local clone of your fork.Ensure your personal fork ispointingupstreamproperly.Create a branch on that personal fork.Make your software changes.Push that branch to your personal GitHub repository (i.e.origin).On thespacetelescopejwqlrepository, 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.Issue Reporting / Feature RequestsUsers 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/issuesSubmit a new ticket on Jira:https://jira.stsci.edu/projects/JWQL/Code of ConductUsers and contributors to thejwqlrepository should adhere to theCode of Conduct.  Any issues or violations pertaining to the Code of Conduct should be brought to the attention of ajwqlteam member or tojwql@stsci.edu.QuestionsAny questions about thejwqlproject or its software can be directed tojwql@stsci.edu.Current Development TeamBryan Hilbert (Project Manager, INS)@bilhbert4Mees Fix (Technical Lead, INS)@mfixstsciMisty Cracraft (INS)@cracraftMike Engesser (INS)@mengesserMaria Pena-Guerrero@penaguerreroBen Sunnquist (INS)@bsunnquistBrian York (INS)@york-stsciBradley Sappington (INS)@bradleysappingtonMelanie Clarke (INS)@melanieclarkePast Development Team MembersMatthew Bourque (INS)@bourqueLauren Chambers (INS)@laurenmariettaJoe Filippazzo (INS)@hover2piGraham Kanarek (INS)@gkanarekTeagan King (INS)@tnking97Sara Ogaz (DMD)@SaOgazCatherine Martlin (INS)@catherine-martlinJohannes Sahlmann (INS)@Johannes-SahlmannShannon Osborne (INS)@shanosborneAcknowledgments:Faith Abney (DMD)Joshua Alexander (DMD)@obviousrebelAnastasia Alexov (DMD)Sara Anderson (DMD)Tracy Beck (INS)Francesca Boffi (INS)@frboffiClara Brasseur (DMD)@ceb8Matthew Burger (DMD)Steven Crawford (DMD)@stscicrawfordJames Davies (DMD)@jdavies-stRosa Diaz (INS)@rizeladiazVan Dixon (INS)Larry Doering (ITSD)Tom Donaldson (DMD)@tomdonaldsonKim DuPrie (DMD)Jonathan Eisenhamer (DMD)@stscieisenhamerBen Falk (DMD)@falkbenAnn Feild (OPO)Mike Fox (DSMO)@mfox22Scott Friedman (INS)Alex Fullerton (INS)@awfullertonMacarena Garcia Marin (INS)Lisa Gardner (DMD)Vera Gibbs (ITSD)Catherine Gosmeyer (INS)@cgosmeyerPhil Grant (ITSD)Dean Hines (INS)Sherie Holfeltz (INS)@stholfeltzJoe Hunkeler (DMD)@jhunkelerCatherine Kaleida (DMD)@ckaleidaDeborah Kenny (DMD)Jenn Kotler (DMD)@jennehDaniel Kühbacher (Goddard)@DanielKuebiMark Kyprianou (DMD)@mkypStephanie La Massa (INS)Matthew Lallo (INS)Karen Levay (DMD)Crystal Mannfolk (SCOPE)@cmannfolkGreg Masci (ITSD)Jacob Matuskey (DMD)@jmatuskeyMargaret Meixner (INS)Christain Mesh (DMD)@cam72camPrem 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)@rendinamMassimo Robberto (INS)@mrobbertoMary Romelfanger (DMD)Elena Sabbi (INS)Bernie Shiao (DMD)Matthew Sienkiewicz (ITSD)Arfon Smith (DSMO)@arfonLinda Smith (INS)Patrick Taylor (ITSD)Dave Unger (ITSD)Jeff Valenti (JWSTMO)@JeffValentiJeff Wagner (ITSD)Thomas Walker (ITSD)Geoff Wallace (DMD)Lara Wilkinson (OPO)Alex Yermolaev (ITSD)@alexyermolaevJoe Zahn (ITSD)