Skip to content

Commit 59197f6

Browse files
committed
README update
1 parent cca32a9 commit 59197f6

2 files changed

Lines changed: 19 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,33 @@ Simialr to the SubmissionReportDashboard only uses Python Shiny instead of Dash.
3434

3535

3636
## WarningAggregator.ipynb and WarningAggregator.py
37-
37+
Currently, the Submission Portal does not have aggreation for the Warnings that are generated by data updates. This can make it difficult to see if the updates that are about to be applied are correct. These programs will aggregate all the warnings and display them in a paired manner so that it is easier to see what changes are about to be applied.
38+
39+
Both scripts take the following configurations. In the notebook you will find these in a marked cell, edit that cell to need. For the script, the configurations are provided in a YAML file (see *warning_configs.yml* for an example)
40+
41+
**subid**: A list of the submission IDs to be checked. Submission IDs can be obtained from the Submission Portal
42+
**severity**: Should be set to 'All'
43+
**nodelist**: A list of the nodes that should be checked for Warnings
44+
**outputdirectory**: A local directory where output can be written
45+
**tier**: The tier to use, shoudl be either 'stage' or 'prod'
46+
47+
**Script runtime options**
48+
- -c/--configfile: The YAML configuration file
49+
- -v/--verbose: The level of verbosity. Add more v's to be more verbose.
3850

3951

4052
## SubmissionReset.py
4153
This script resets the inactivity timer for all of your **New** or **In Progress submissions** to the current date.
4254

55+
**Script runtime options**
56+
- -t/--tier: The tier to check. Should be either 'prod' or 'stage'
57+
- -v/--verbose: The level of verbosity. Add more v's to be more verbose.
58+
4359
## SubmissionResetGUI.py
4460
This is a graphical version (Python Dash) of the *SubmissionReset.py* script. Select a tier from the drop-down and a table of your current New and In Progress submissions will be generated. Select the submissions you wish to reset the inactivity timer on and then click on the *Reset Time on Selected Submissions* button below the table. Each submission selected will be reset to the current date.
4561

4662
To use, run the script ($ python3 SubmissionResetGUI.py) and then bring up a browser and navigate to http://localhost:8050.
4763

4864
**Required Python Libraries**
49-
dash, dash_bootstrap_components, requests, pandas, datetime, pytz
65+
dash, dash_bootstrap_components, requests, pandas, datetime, pytz
66+

‎SubmissionResetGUI.py‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
import requests
55
import pandas as pd
66
import io
7-
import json
87
from datetime import datetime, timezone
98
from pytz import timezone as tz
109
import os

0 commit comments

Comments
 (0)