Skip to content

Commit 4a9ff01

Browse files
bourquebourque
authored
Merge pull request spacetelescope#809 from spacetelescope/v1.0.0
Release v1.0.0 [main]
2 parents 0335e94 + ce06911 commit 4a9ff01

File tree

150 files changed

+3541
-3086
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

150 files changed

+3541
-3086
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve.
4+
title: (Concise description of bug)
5+
labels: bug
6+
---
7+
8+
**Describe the bug**
9+
A clear and detailed description of what the bug is.
10+
11+
**To Reproduce**
12+
Steps to reproduce the behavior:
13+
1. Go to '...'
14+
2. Click on '....'
15+
3. Scroll down to '....'
16+
4. See error
17+
18+
**Expected behavior**
19+
A description of what you expected to happen.
20+
21+
**Additional context**
22+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for the JWQL project.
4+
title: Concise description of the feature request
5+
labels: enhancement
6+
---
7+
8+
**Is your feature request related to a problem? Please describe.**
9+
A detailed description of what the problem is. Ex. I'm always frustrated when [...]
10+
11+
**Describe the solution you'd like**
12+
A clear description of what you want to happen.
13+
14+
**Describe alternatives you've considered**
15+
A clear description of any alternative solutions or features you've considered.
16+
17+
**Additional context**
18+
Add any other context or screenshots about the feature request here.

‎.github/workflows/ci.yml

+5
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,11 @@ jobs:
2121
with:
2222
activate-environment: jwql-${{ matrix.python-version }}
2323

24+
- name: Bandit Check
25+
uses: jpetrucciani/[email protected]
26+
continue-on-error: true
27+
if: runner.os == 'Linux'
28+
2429
- name: Build jwql conda environment and run tests
2530
shell: bash -l {0}
2631
run: |

‎.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
*.pyc
22
*.fits
33
*.ipynb_checkpoints/
4-
/jwql/utils/config.json
4+
config.json
55
build/
66
dist/
77
jwql.egg-info/

‎CHANGES.rst

+67
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,70 @@
1+
1.0.0 (2021-10-05)
2+
===================
3+
4+
New Features
5+
------------
6+
7+
Project & API Documentation
8+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
9+
10+
- Included documentation describing the algorithms used for instrument monitors
11+
- Included templates for bug reports and feature requests as well as a link to submit issues on the ``home`` page
12+
- Included ``Documentation`` option on instrument drop down menu in the navigation bar
13+
14+
15+
Web Application
16+
~~~~~~~~~~~~~~~
17+
18+
- All relevant instruments (NIRCam, NIRISS, NIRSpec) are incorporated into the Bias Monitor
19+
- The generalized pipeline function from ``pipeline_tools.py`` is used for image calibration
20+
- For exposures containing multiple integrations, created thumbnail image for only a single ingtegration
21+
- Implemented tests for all Monitor webpages
22+
23+
24+
``jwql`` Repository
25+
~~~~~~~~~~~~~~~~~~~
26+
27+
- Modified filesystem to reflect MAST-like organizational structure
28+
- Implemented application security tools into GitHub Actions builds
29+
- Switched filesystem to use latest DMS build
30+
- Improved configuration file handling
31+
32+
33+
Bug Fixes
34+
---------
35+
36+
Project & API Documentation
37+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
38+
39+
- Include API Docs for all modules, classes, and functions in ReadTheDocs
40+
41+
42+
Web Application
43+
~~~~~~~~~~~~~~~
44+
45+
- Included various fixes and improvements suggested during stakeholder demonstrations
46+
- Fixed ``View Image``, ``View Proposal``, and ``View Header`` buttons
47+
- Updated dashboard such that ``NULL`` Monitor Status values were fixed
48+
- Updated options that users can select for general image queries
49+
- Eliminated pop-up warning when viewing fits file headers in the web app
50+
- Removed login button on homepage and supporting authentication code and replaced with SSO authentication
51+
52+
53+
``jwql`` Repository
54+
~~~~~~~~~~~~~~~~~~~
55+
56+
- Fixed Dark Monitor failure due to dither point keyword values in data
57+
- Addressed Dark Monitor failure with data including 64-bit integers
58+
- Resolved the NIRSpec amp boundary issue
59+
- Fixed missing reference file error handling with latest DMS build in Readnoise Monitor
60+
- Ensured Dark, Bias, and Readnoise Monitors complete successfully with latest DMS build
61+
- Included read persmissions for database tables
62+
- Performed flake8 sweep of the code repository
63+
- Updated software to support the latest versions of ``bokeh`` and ``pysiaf``
64+
- Removed dependencies on the astroconda channel
65+
66+
67+
168
0.26.0 (2021-03-30)
269
===================
370

‎MANIFEST.in

+8-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
1+
include CODE_OF_CONDUCT.md
12
include README.md
23
include LICENSE
3-
include environment_python_3_5.yml
4-
include environment_python_3_6.yml
4+
include CHANGES.rst
5+
include environment_python_3_7.yml
6+
include environment_python_3_8.yml
57
include setup.py
8+
include requirements.txt
9+
include rtd_requirements.txt
10+
include jwql/example_config.json
611

712
recursive-include notebooks *
813
recursive-include style_guide *
914
recursive-include typing_demo *
1015
recursive-include jwql/database/monitor_table_definitions *.txt
1116

12-
exclude *.pyc
17+
exclude *.pyc

‎README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ The package should now appear if you run `conda list jwql`.
104104

105105
### Configuration File
106106

107-
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](https://github.com/spacetelescope/jwql/wiki/Config-file) for instructions on how to provide this file.
107+
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](https://github.com/spacetelescope/jwql/wiki/Config-file) for instructions on how to provide this file.
108108

109109

110110
## Citation
@@ -186,6 +186,7 @@ Any questions about the `jwql` project or its software can be directed to `jwql@
186186
- James Davies (DMD) [@jdavies-st](https://github.com/jdavies-st)
187187
- Rosa Diaz (INS) [@rizeladiaz](https://github.com/rizeladiaz)
188188
- Van Dixon (INS)
189+
- Larry Doering (ITSD)
189190
- Tom Donaldson (DMD) [@tomdonaldson](https://github.com/tomdonaldson)
190191
- Kim DuPrie (DMD)
191192
- Jonathan Eisenhamer (DMD) [@stscieisenhamer](https://github.com/stscieisenhamer)
@@ -194,6 +195,7 @@ Any questions about the `jwql` project or its software can be directed to `jwql@
194195
- Mike Fox (DSMO) [@mfox22](https://github.com/mfox22)
195196
- Scott Friedman (INS)
196197
- Alex Fullerton (INS) [@awfullerton](https://github.com/awfullerton)
198+
- Macarena Garcia Marin (INS)
197199
- Lisa Gardner (DMD)
198200
- Vera Gibbs (ITSD)
199201
- Catherine Gosmeyer (INS) [@cgosmeyer](https://github.com/cgosmeyer)
@@ -202,9 +204,12 @@ Any questions about the `jwql` project or its software can be directed to `jwql@
202204
- Sherie Holfeltz (INS) [@stholfeltz](https://github.com/stholfeltz)
203205
- Joe Hunkeler (DMD) [@jhunkeler](https://github.com/jhunkeler)
204206
- Catherine Kaleida (DMD) [@ckaleida](https://github.com/ckaleida)
207+
- Deborah Kenny (DMD)
205208
- Jenn Kotler (DMD) [@jenneh](https://github.com/jenneh)
206209
- Daniel Kühbacher (Goddard) [@DanielKuebi](https://github.com/DanielKuebi)
207210
- Mark Kyprianou (DMD) [@mkyp](https://github.com/mkyp)
211+
- Stephanie La Massa (INS)
212+
- Matthew Lallo (INS)
208213
- Karen Levay (DMD)
209214
- Crystal Mannfolk (SCOPE) [@cmannfolk](https://github.com/cmannfolk)
210215
- Greg Masci (ITSD)
@@ -221,13 +226,15 @@ Any questions about the `jwql` project or its software can be directed to `jwql@
221226
- Matt Rendina (DMD) [@rendinam](https://github.com/rendinam)
222227
- Massimo Robberto (INS) [@mrobberto](https://github.com/mrobberto)
223228
- Mary Romelfanger (DMD)
229+
- Elena Sabbi (INS)
224230
- Bernie Shiao (DMD)
225231
- Matthew Sienkiewicz (ITSD)
226232
- Arfon Smith (DSMO) [@arfon](https://github.com/arfon)
227233
- Linda Smith (INS)
228234
- Patrick Taylor (ITSD)
229235
- Dave Unger (ITSD)
230236
- Jeff Valenti (JWSTMO) [@JeffValenti](https://github.com/JeffValenti)
237+
- Jeff Wagner (ITSD)
231238
- Thomas Walker (ITSD)
232239
- Geoff Wallace (DMD)
233240
- Lara Wilkinson (OPO)

‎docs/source/conf.py

+10-3
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,13 @@
2525

2626
# -- General configuration ------------------------------------------------
2727

28+
# Configure Django for autodoc usage
29+
import django
30+
from django.conf import settings
31+
32+
settings.configure(LOGGING_CONFIG=None)
33+
django.setup()
34+
2835
# If your documentation needs a minimal Sphinx version, state it here.
2936
#
3037
# needs_sphinx = '1.0'
@@ -51,7 +58,7 @@
5158
# The master toctree document.
5259
master_doc = 'index'
5360

54-
# Numpy doc setting, right now this supresses some warnings, not exactly sure why?
61+
# Numpy doc setting, currently supresses some warnings, not exactly sure why?
5562
numpydoc_show_class_members = False
5663

5764
# General information about the project.
@@ -77,8 +84,8 @@
7784
# Usually you set "language" from the command line for these cases.
7885
language = None
7986

80-
# This is a fix for warnings because of sphinx-autodoc interaction for classes, however it removes
81-
# method table from the docs.
87+
# This is a fix for warnings because of sphinx-autodoc interaction for classes,
88+
# however it removes method table from the docs.
8289
numpydoc_show_class_members = False
8390

8491
# List of patterns, relative to source directory, that match files and

‎docs/source/index.rst

+1-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@
99
Welcome to the ``jwql`` API documentation!
1010
==========================================
1111

12-
The JWST Quicklook Application (``JWQL``) is a database-driven web application and automation framework for JWST instrument monitoring and performance trending. This site serves as the official API documentation for
13-
the project. The ``JWQL`` website can currently be found at `https://dljwql.stsci.edu <http://dljwql.stsci.edu>`_. The ``JWQL`` source code, installation instructions, and instructions for issue reporting and feature requests can be found in the `jwql GitHub repository <https://github.com/spacetelescope/jwql>`_.
12+
The JWST Quicklook Application (``JWQL``) is a web application and automation framework for analyzing and monitoring the JWST instruments and their data. This site serves as the official API documentation for the project. The ``JWQL`` source code, installation instructions, and instructions for issue reporting and feature requests can be found in the `jwql GitHub repository <https://github.com/spacetelescope/jwql>`_.
1413

1514
.. toctree::
1615
:maxdepth: 1

‎docs/source/tests.rst

+18-7
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,21 @@ test_bad_pixel_monitor.py
1414
:members:
1515
:undoc-members:
1616

17-
1817
test_bias_monitor.py
1918
--------------------
2019
.. automodule:: jwql.tests.test_bias_monitor
2120
:members:
2221
:undoc-members:
2322

24-
test_calculations.py
25-
--------------------
26-
.. automodule:: jwql.tests.test_calculations
23+
test_bokeh_templating
24+
---------------------
25+
.. automodule:: jwql.tests.test_bokeh_templating
2726
:members:
2827
:undoc-members:
2928

30-
test_context_processors.py
31-
--------------------------
32-
.. automodule:: jwql.tests.test_context_processors
29+
test_calculations.py
30+
--------------------
31+
.. automodule:: jwql.tests.test_calculations
3332
:members:
3433
:undoc-members:
3534

@@ -45,6 +44,12 @@ test_data_containers.py
4544
:members:
4645
:undoc-members:
4746

47+
test_database_interface.py
48+
--------------------------
49+
.. automodule:: jwql.tests.test_database_interface
50+
:members:
51+
:undoc-members:
52+
4853
test_edb.py
4954
-----------
5055
.. automodule:: jwql.tests.test_edb
@@ -99,6 +104,12 @@ test_preview_image.py
99104
:members:
100105
:undoc-members:
101106

107+
test_readnoise_monitor.py
108+
-------------------------
109+
.. automodule:: jwql.tests.test_readnoise_monitor
110+
:members:
111+
:undoc-members:
112+
102113
test_setup.py
103114
-------------
104115
.. automodule:: jwql.tests.test_setup

‎docs/source/utils.rst

+36
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22
utils
33
*****
44

5+
anomaly_query_config.py
6+
-----------------------
7+
.. automodule:: jwql.utils.anomaly_query_config
8+
:members:
9+
:undoc-members:
10+
511
calculations.py
612
---------------
713
.. automodule:: jwql.utils.calculations
@@ -14,6 +20,18 @@ constants.py
1420
:members:
1521
:undoc-members:
1622

23+
crds_tools.py
24+
-------------
25+
.. automodule:: jwql.utils.crds_tools
26+
:members:
27+
:undoc-members:
28+
29+
credentials.py
30+
--------------
31+
.. automodule:: jwql.utils.credentials
32+
:members:
33+
:undoc-members:
34+
1735
instrument_properties.py
1836
------------------------
1937
.. automodule:: jwql.utils.instrument_properties
@@ -26,12 +44,30 @@ logging_functions.py
2644
:members:
2745
:undoc-members:
2846

47+
mast_utils.py
48+
-------------
49+
.. automodule:: jwql.utils.mast_utils
50+
:members:
51+
:undoc-members:
52+
2953
monitor_template.py
3054
-------------------
3155
.. automodule:: jwql.utils.monitor_template
3256
:members:
3357
:undoc-members:
3458

59+
monitor_utils.py
60+
----------------
61+
.. automodule:: jwql.utils.monitor_utils
62+
:members:
63+
:undoc-members:
64+
65+
organize_filesystem.py
66+
----------------------
67+
.. automodule:: jwql.utils.organize_filesystem
68+
:members:
69+
:undoc-members:
70+
3571
permissions.py
3672
--------------
3773
.. automodule:: jwql.utils.permissions

‎docs/source/website.rst

+12
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,12 @@ manage.py
3838
:members:
3939
:undoc-members:
4040

41+
monitor_views.py
42+
----------------
43+
.. automodule:: jwql.website.apps.jwql.monitor_views
44+
:members:
45+
:undoc-members:
46+
4147
oauth.py
4248
--------
4349
.. automodule:: jwql.website.apps.jwql.oauth
@@ -50,6 +56,12 @@ settings.py
5056
:members:
5157
:undoc-members:
5258

59+
urls.py
60+
-------
61+
.. automodule:: jwql.website.apps.jwql.urls
62+
:members:
63+
:undoc-members:
64+
5365
views.py
5466
--------
5567
.. automodule:: jwql.website.apps.jwql.views

0 commit comments

Comments
 (0)