Merge branch '703-feedback-on-tom-swift-module-from-swift-operations-team' into dev

Author: phycodurus

.github/workflows/run-tests.yml

@@ -9,21 +9,20 @@ jobs:
     - uses: actions/checkout@v2
     - uses: actions/setup-python@v2
       with:
-        python-version: '3.x'
+        python-version: '3.11'
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         python -m pip install poetry
-        poetry install
-        pip install -I flake8
+        poetry install --with lint
     - name: Style Checks
-      run: flake8 tom_* --exclude=*/migrations/* --max-line-length=120
+      run: poetry run flake8 tom_* --exclude=*/migrations/* --max-line-length=120
 
   run_tests:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10"]
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
         os: [ubuntu-latest]
     steps:
       - uses: actions/checkout@v2
@@ -36,4 +35,4 @@ jobs:
           python -m pip install poetry
           poetry install
       - name: Run tests
-        run: echo "write tests!"
+        run: poetry run python -m unittest discover -v

README.md

@@ -1,6 +1,4 @@
 # tom_swift
-_Note: This repository is under active development. It is currently in alpha-release stage. Feedback is welcome._
-
 [Neil Gehrels Swift Observatory](https://swift.gsfc.nasa.gov/index.html) facility module for TOM Toolkit. This module uses the
 [Swift TOO API](https://www.swift.psu.edu/too_api/) for all its interactions with the _Swift_ Observatory. When installed and
 configured, your TOM can query target visibility, submit TOO observation requests to Swift, and check TOO observation status.

poetry.lock

@@ -9,10 +9,12 @@ readme = "README.md"
 packages = [{include = "tom_swift"}]
 
 [tool.poetry.dependencies]
-python = ">=3.8,<3.12"
-tomtoolkit = "^2.14"
-BatAnalysis = "^1.0"
+python = ">=3.8.1,<3.12"
+tomtoolkit = ">=2.15"
+swifttools = "<4"
 
+[tool.poetry.group.lint.dependencies]
+flake8 = "~6.0"
 
 [tool.poetry-dynamic-versioning]
 enable = true

pyproject.toml

@@ -72,6 +72,9 @@ def resolve_target(self, target: Target):
         return resolved_target
 
 
+# define OTHER_CHOICE so it can be used consistently and tested against
+SWIFT_OTHER_CHOICE = 'Other (please specify)'
+
 #
 # Urgency
 #
@@ -93,7 +96,7 @@ def resolve_target(self, target: Target):
     ('Supernova', 'Supernova'),
     ('Tidal Disruption Event', 'Tidal Disruption Event'),
     ('X-Ray Transient', 'X-Ray Transient'),
-    ('Other (please specify)', 'Other (please specify)'),
+    (SWIFT_OTHER_CHOICE, SWIFT_OTHER_CHOICE),
 ]
 
 
@@ -103,6 +106,7 @@ def resolve_target(self, target: Target):
 # Note that:
 # >>> TOO().obs_types
 # ['Spectroscopy', 'Light Curve', 'Position', 'Timing']
+#
 def get_observation_type_choices():
     """Returns a list of tuples for the observation type choices.
 
@@ -119,12 +123,35 @@ def get_observation_type_choices():
 #
 # Instruments
 #
+# could also use TOO().instruments, which is [ 'XRT', 'BAT', 'UVOT']
+# but that doesn't include the full names
 SWIFT_INSTRUMENT_CHOICES = [
     ('UVOT', 'UV/Optical Telescope (UVOT)'),
     ('XRT', 'X-ray Telescope (XRT)'),
     ('BAT', 'Burst Alert Telescope (BAT)'),
 ]
 
+#
+# GRB Detectors
+#
+
+
+def get_grb_detector_choices():
+    """Returns a list of tuples for the GRB detector choices.
+
+    Since the TOO() object has property describing the valid GRB detectors,
+    use that to create the choices list of tuples (e.g. [('Swift/BAT', 'Swift/BAT'), ('Fermi/LAT',
+    'Fermi/LAT'), ...]).
+    """
+    grb_detector_choices = []
+    for mission in TOO().mission_names:
+        if mission != 'ANTARES':
+            grb_detector_choices.append((mission, mission))
+
+    # add the SWIFT_OTHER_CHOICE
+    grb_detector_choices.append((SWIFT_OTHER_CHOICE, SWIFT_OTHER_CHOICE))
+    return grb_detector_choices
+
 
 #
 # XRT Modes
@@ -160,6 +187,26 @@ def get_observation_type_choices():
 # Any string will validate:
 # >>> too.uvot_mode = "I think I want all UV filters for this, whatever the UVOT team recommends."
 
+SWIFT_UVOT_FILTER_MODE_CHOICES = [
+    (0x015a, 'uvm2 (0x015a)'),
+    (0x011e, 'uvw2 (0x011e)'),
+    (0x01aa, 'u (0x01aa)'),
+    (0x018c, 'uvw1 (0x018c)'),
+    (0x2016, 'B (0x2016)'),
+    (0x2005, 'V (0x2005)'),
+    (0x2019, 'white (0x2019)'),
+    (0x209a, 'three optical filters (0x209a)'),
+    (0x308f, 'three NUV filters (0x308f)'),
+    (0x30d5, 'four UV/NUV filters (0x30d5)'),
+    (0x30ed, 'standard six-filter blue-weighted mode (0x30ed)'),
+    (0x223f, 'heavily weighted six-filter mode; for supernovae and very red objects (0x223f)'),
+    (0x2241, 'all seven optical/UV filters (0x2241)'),
+    (0x0270, ('unscaled six-filter mode to get 6 broadband filters in AT observations with'
+              ' snapshot lengths > 1000s (0x0270)')),
+    (0x9999, 'Filter of the Day (0x9999)'),
+    (SWIFT_OTHER_CHOICE, SWIFT_OTHER_CHOICE),
+]
+
 
 #
 # Monitoring
@@ -172,5 +219,5 @@ def get_monitoring_unit_choices():
     """
     monitoring_unit_choices = []
     for unit in TOO().monitoring_units:
-        monitoring_unit_choices.append((unit, unit))
+        monitoring_unit_choices.append((unit, f'{unit}(s)'))
     return monitoring_unit_choices

tom_swift/swift.py

@@ -11,23 +11,35 @@
 function showHideTargetClassificationFields() {
     const target_classification = document.getElementById('id_target_classification_choices').options[document.getElementById('id_target_classification_choices').selectedIndex].value;
     switch (target_classification) {
-        case 'Other (please specify)':
+        case 'Other (please specify)': // define as SWIFT_OTHER_CHOICE in swift_api.py
             // in this case show the target_classification CharField
             document.getElementById('div_id_target_classification').style.display = '';
             // and hide the grb_detector and grb_triggertime fields
+            document.getElementById('div_id_grb_detector_choices').style.display = 'none';
             document.getElementById('div_id_grb_detector').style.display = 'none';
             document.getElementById('div_id_grb_triggertime').style.display = 'none';
             break;
         case 'GRB':
             // in this case show the grb_detector and grb_triggertime fields
-            document.getElementById('div_id_grb_detector').style.display = '';
+            document.getElementById('div_id_grb_detector_choices').style.display = '';
+            // we do the other-please-specify dance if they want an Other GRB Detector
+            const grb_detector_choice = document.getElementById('id_grb_detector_choices').options[document.getElementById('id_grb_detector_choices').selectedIndex].value;
+            if (grb_detector_choice == 'Other (please specify)') {
+                // in this case show the grb_detector CharField
+                document.getElementById('div_id_grb_detector').style.display = '';
+            } else {
+                // in this case hide the grb_detector CharField
+                document.getElementById('div_id_grb_detector').style.display = 'none';
+            }
+
             document.getElementById('div_id_grb_triggertime').style.display = '';
             // and hide the target_classification CharField
             document.getElementById('div_id_target_classification').style.display = 'none';
             break;
         default:
             // in this case hide all the extra fields
             document.getElementById('div_id_target_classification').style.display = 'none';
+            document.getElementById('div_id_grb_detector_choices').style.display = 'none';
             document.getElementById('div_id_grb_detector').style.display = 'none';
             document.getElementById('div_id_grb_triggertime').style.display = 'none';
             break;
@@ -57,12 +69,19 @@
             // show the xrt_mode field; hide the UVOT fields
             document.getElementById('div_id_xrt_mode').style.display = '';
             document.getElementById('div_id_uvot_mode').style.display = 'none';
+            document.getElementById('div_id_uvot_mode_choices').style.display = 'none';
             document.getElementById('div_id_uvot_just').style.display = 'none';
             break;
         case 'UVOT':
             console.log('UVOT instrument selected');
             // show the uvot_mode and uvot_just fields; hide the xrt_mode fields
-            document.getElementById('div_id_uvot_mode').style.display = '';
+            const uvot_mode = document.getElementById('id_uvot_mode_choices').options[document.getElementById('id_uvot_mode_choices').selectedIndex].value;
+            if (uvot_mode == 'Other (please specify)') {
+                document.getElementById('div_id_uvot_mode').style.display = '';
+            } else {
+                document.getElementById('div_id_uvot_mode').style.display = 'none';
+            }
+            document.getElementById('div_id_uvot_mode_choices').style.display = '';
             document.getElementById('div_id_uvot_just').style.display = '';
             document.getElementById('div_id_xrt_mode').style.display = 'none';
             break;
@@ -71,6 +90,7 @@
             // not sure what to show or hide here (hide everything?)
             document.getElementById('div_id_xrt_mode').style.display = 'none';
             document.getElementById('div_id_uvot_mode').style.display = 'none';
+            document.getElementById('div_id_uvot_mode_choices').style.display = 'none';
             document.getElementById('div_id_uvot_just').style.display = 'none';
             break;
     }
@@ -108,6 +128,10 @@
     }
 };
 
+function showExposureAccordianOnError() {
+    const exposureAccordion = document.getElementById('exposure-visit-information');
+    exposureAccordion.classList.add('show');
+}
 </script>
 
 <script type="text/javascript">
@@ -120,7 +144,7 @@
 <!-- see also script element at end of file -->
 
 {{ form|as_crispy_errors }}
-<h1>Submit Request to Neil Gehrels Swift Observatory</h1>
+<h1>Submit Request to Neil Gehrels Swift Observatory for <a href="{% url 'targets:detail' pk=target.id %}">{{target.name}}</a></h1>
 
 
 {% if target.type == 'SIDEREAL' %}
@@ -150,7 +174,7 @@ <h4>Resolved Target Information ({{ resolver }})</h4>
         </dl>
         <hr>
         <!-- display tom_swift Facility version -->
-        <p><em>TOM Toolit Facility (<a href="https://github.com/TOMToolkit/tom_swift">tom_swift</a>) version {{ version }}</em></p>
+        <p><em>TOM Toolkit Facility (<a target="_blank" href="https://github.com/TOMToolkit/tom_swift">tom_swift</a>) version {{ version }}</em></p>
     </div>
     <!-- Column 2 -->
     <div class="col-md-6">
@@ -180,19 +204,32 @@ <h4>Resolved Target Information ({{ resolver }})</h4>
  -->
 <script type="text/javascript">
     var el1 = document.getElementById("div_id_target_classification_choices");
-    el1.addEventListener("click", showHideTargetClassificationFields);
+    el1.addEventListener("change", showHideTargetClassificationFields);
 
     var el2 = document.getElementById("div_id_instrument");
-    el2.addEventListener("click", showHideInstrumentModeFields);
+    el2.addEventListener("change", showHideInstrumentModeFields);
+
+    var el7 = document.getElementById("div_id_uvot_mode_choices");
+    el7.addEventListener("change", showHideInstrumentModeFields);
 
     var el3 = document.getElementById("div_id_num_of_visits");
-    el3.addEventListener("click", showHideMonitoringFields);
+    el3.addEventListener("change", showHideMonitoringFields);
 
     var el4 = document.getElementById("div_id_tiling");
-    el4.addEventListener("click", showHideTilingFields);
+    el4.addEventListener("change", showHideTilingFields);
 
     var el5 = document.getElementById("div_id_proposal");
-    el5.addEventListener("click", showHideSwiftGIProposalFields);
+    el5.addEventListener("change", showHideSwiftGIProposalFields);
+
+    var el6 = document.getElementById("div_id_grb_detector_choices");
+    //el6.addEventListener("click", showHideGRBDetectionFields);
+    el6.addEventListener("change", showHideTargetClassificationFields);
+
+    var el7 = document.getElementById("id_exposure");
+    el7.addEventListener("invalid", showExposureAccordianOnError);
+
+    var el8 = document.getElementById("id_exp_time_just");
+    el8.addEventListener("invalid", showExposureAccordianOnError);
 </script>
 
 {% endblock %}

tom_swift/swift_api.py

@@ -0,0 +1,13 @@
+import unittest
+
+
+class SwiftFacilityTest(unittest.TestCase):
+
+    def test_something(self):
+        expected = True
+        actual = True
+        self.assertEqual(expected, actual)
+
+
+if __name__ == '__main__':
+    unittest.main()