Jwql

===================

New Features
------------

Project & API Documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Updated the notebook exemplifying how to perform an engineering database (EDB) telemetry query.
- Updated the README for the ``style_guide`` directory.

Web Application
~~~~~~~~~~~~~~~

- Added form on preview image pages to allow users to submit image anomalies.
- Added buttons for users to download the results of EDB telemetry queries as CSV files.
- Enabled users to search for or navigate to program numbers without requiring leading zeros (i.e. "756" is now treated equivalently to "00756").
- Enabled authentication for EDB queries via the web login (rather than requiring authentication information to be present in the configuration file).
- Added custom 404 pages.
- Added adaptive redirect feature so that users are not sent back to the homepage after login.
- Added more descriptive errors if a user tries to run the web application without filling out the proper fields in the configuration file.

``jwql`` Repository
~~~~~~~~~~~~~~~~~~~

- Replaced all EDB interface code within ``jwql`` with the new ``jwedb`` `package<https://github.com/spacetelescope/jwst-dms-edb>`_.
- Fully incorporated Python 3.5 testing into the Jenkins test suite.

Bug Fixes
---------

Web Application
~~~~~~~~~~~~~~~

- Fixed bug in which dashboard page would throw an error.
- Fixed incorrect dashboard axis labels.

===================

New Features
------------

Project & API Documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Added guidelines to the style guide for logging the execution of instrument monitors
- Added example usage of logging in the ``example.py`` module

Web Application
~~~~~~~~~~~~~~~

- Modified various web app views to enable faster loading times
- Modified archive and preview image views to only display data for an authenticated user
- Added views for MIRI and NIRSpec Data Trending Monitors, which monitors the behavior of select MIRI and NIRSpec Engineering Database mnemonics over time

``jwql`` Repository
~~~~~~~~~~~~~~~~~~~

- Added Dark Monitor module, which monitors the dark current and hot pixel populations for each JWST instrument
- Added software for producing MIRI and NIRSpec Data Trending Monitors (described above)
- Modified ``generate_preview_images`` module to support the creation of preview images for stage 3 data products
- Refactored ``monitor_filesystem`` to utilize PostgreSQL database tables to store archive filesystem statistics
- Configured ``codecov`` for the project. The project homepage can be found at https://codecov.io/gh/spacetelescope/jwql
- Modified ``logging_functions`` module to enable dev, test, and production logging environments
- Added convenience decorator to ``logging_functions`` module to time the execution of a function or method
- Modified ``monitor_cron_jobs`` module to make use of updated ``logging_functions``

Bug Fixes
---------

Web Application
~~~~~~~~~~~~~~~

- Fixed API views to only return the basenames of file paths, instead of full directory names

``jwql`` Repository
~~~~~~~~~~~~~~~~~~~

- Fixed ``logging_functions`` module to properly parse new format of ``INSTALL_REQUIRES`` dependency in ``setup.py`` for logging system dependencies and their versions
- Fixed ``Jenkinsfile`` to not allow for one failed unit test in Jenkins builds

===================

New Features
------------

Project & API Documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Added instructions in ``README`` that details how to supply the required ``config.json`` configuration file
- Updated installation instructions in ``README`` to be more comprehensive
- Updated API docs for JavaScript functions in web app

Web Application
~~~~~~~~~~~~~~~

- Added a webpage for interacting with the JWST Engineering Database (EDB), including searching for available mneumonics and plotting mneumonic time series data
- Added ``context_processors`` module that provides functions that define context inherent to all views
- Added display of package version in footer
- Moved all JavaScript functions in HTML templates into the ``jwql.js`` module
- Modified links to external webpages to open in new tab

``jwql`` Repository
~~~~~~~~~~~~~~~~~~~

- Added ``__version__`` package attribute
- Updated ``install_requires`` in ``setup.py`` to adhere to best practices
- Added template branch and supporting documentation for how to contribute a new webpage in the ``jwql`` web application
- Added custom error message if required ``config.json`` configuration file is missing
- Updated ``database_interface`` module to dynamically create tables to store instrument monitoring data from user-supplied table definition files
- Added Jupyter notebook that describes how to integrate ``auth.mast`` service in a ``djang web application
- Updated ``utils.filename_parser`` function to handle stage 2C and guider filenames
- Updated ``utils.filename_parser`` function to always provide an ``instrument`` key, as needed by several webpages within the web app
- Added separate file suffix type lists in ``constants.py`` module
- Added ``reset_database`` module that resets and rebuilds a database provided by the ``connection_string`` key in the ``config.json`` configuration file
- Added ``pytest`` results file in order to fix Jenkins CI builds

Bug Fixes
---------

Web Application
~~~~~~~~~~~~~~~

- Fixed navbar padding
- Fixed broken instrument logos on homepage

``jwql`` Repository
~~~~~~~~~~~~~~~~~~~

- Fixed ``monitor_mast`` module to actually be command-line executable

===================

New Features
------------

Project & API Documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Added a wiki page for how to do a software release
- Added a wiki page with a checklist for contributors and reviewers of pull requests
- Added a wiki page about how the web server is configured
- Defined specific variable value/type standards for JWST instruments and program/proposal identifiers in the Style Guide

Web Application
~~~~~~~~~~~~~~~
- Added authentication to all pages using the ``auth.mast`` service provided by the Archive Services Branch
- Implemented AJAX requests to load the ``thumbnails.html`` and ``archive.html`` pages
- Used regular expressions to restrict URLs to specific patterns
- Added a loading widget while thumbnails compile

``jwql`` Repository
~~~~~~~~~~~~~~~~~~~
- Added interface with the JWST DMS engineering database: ``utils.engineering_database``
- Expanded ``utils.filename_parser`` to handle time series and DMS stage 3 file names
- Consolidated important constants in new ``utils.constants`` module

Bug Fixes
---------

Web Application
~~~~~~~~~~~~~~~

- Updated permissions in ``nginx`` settings to fix bug where dashboard page would not display

===================

This is the first release of the new release procedures of ``jwql``. The development team is now developing in release-driven sprints, so future releases will be less frequent, but with more changes

Changes since the ``0.15.3`` release include:

New Features
------------

``jwql`` ``conda`` Environment
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Updated ``bokeh`` to version 1.0
- Updated ``django`` to fix security issues
- Added ``pandas`` as a dependency

Project & API Documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Added a project description in the API docs
- Added web app API docs

Web Application
~~~~~~~~~~~~~~~
- Made changes to the code to get it working on the web development server
- Added several REST API services
- Added API documentation button to the navbar and anded link to API documentation in the ``about`` page
- Added instrument-specific documentation button to the instrument landing pages
- Replaced ``monitor_mast`` donut charts with bar charts
- Removed dashboard and database query buttons from homepage
- Added form to homepage that allows user to view preview images for a given rootname or proposal number
- Changed URL patters to allow for separation between nominal web app and REST API service
- Added ``monitor_cron_jobs`` monitor that builds and renders a table displaying ``cron`` job execution status

``jwql`` Repository
~~~~~~~~~~~~~~~~~~~
- Added badges to the ``README``
- Configured ``pyup`` service for the ``jwql`` repository via ``.pyup.yml`` file
- Added a separate ``requirement.txt`` file to keep track of requirements needed by ReadTheDocs and the ``pyup`` service
- Added various ``jwql`` presentations in separate ``presentations/`` directory

Other Changes
~~~~~~~~~~~~~
- Changed ``logging_functions.py`` to be more conservative on when to write log files to the production area
- Added ``plotting.py`` module (and supporting unit tests), which stores various plotting-related functions

===================

- Added ``.readthedocs.yml``, which configures the ``jwql`` project documentation with ReadtheDocs