WIP: going over the glossary section in the report

agasc/supplement/magnitudes/mag_estimate_report.py

@@ -251,6 +251,7 @@ def multi_star_html(
                 {
                     "id": "other_stars",
                     "title": "Other Stars",
+                    "description": "",
                     "stars": self.agasc_stats["agasc_id"][
                         ~np.in1d(self.agasc_stats["agasc_id"], agasc_ids)
                     ],
@@ -1050,4 +1051,16 @@ def email_bad_obs_report(bad_obs, to, sender=SENDER):
         observation that the Kalman filter is getting any star centroid at all. This
         includes measurements out to 5 arcsec box halfwidth, so potentially 7 arcsec
         radial offset.""",
+    "mag<sub>obs</sub>":
+        "Estimated magnitude. This will be the magnitude in the supplement after the update",
+    "mag<sub>catalog</sub>": "The magnitude in the AGASC catalog.",
+    "&delta;<sub>mag cat</sub>": """Difference between observed and catalog magnitudes:
+        mag<sub>obs</sub> - mag<sub>catalog</sub>""",
+    "&delta;<sub>mag</sub>/&sigma;<sub>mag</sub>": """
+        Difference between observed and catalog magnitudes divided by catalog magnitude error:
+        &delta;<sub>mag</sub>/&sigma;<sub>mag</sub>""",
+    "&delta;<sub>mag</sub>":
+        "Variation in observed magnitude since last version of AGASC supplement",
+    "&delta;<sub>&sigma;</sub>":
+        "Variation in observed magnitude standard deviation since last version of AGASC supplement"
 }

agasc/supplement/magnitudes/templates/run_report.html

@@ -56,6 +56,14 @@ <h2> {{ info.report_date }} Update Report </h2>
     {%- for section in sections %}
     <a name="{{ section.id }}"> </a>
     <h3> {{ section.title }} </h3>
+
+    <p>
+      {{ section.description }}
+      Rows marked red are stars that have a failed observation in this run.
+      Rows marked yellow are stars that have a failed observation in their history, but not in this
+      run.
+    </p>
+
     <table class="table table-hover">
       <tr>
       <tr>
@@ -137,6 +145,9 @@ <h3> {{ section.title }} </h3>
     <a name="failures"> </a>
     {%- if failures %}
     <h3> Failures </h3>
+
+    <p> Processing of these stars raised an exception. </p>
+
     <table class="table table-hover">
       <tr>
         <th> AGASC ID </th>

agasc/supplement/magnitudes/templates/star_report.html

@@ -68,6 +68,12 @@ <h3> Timeline </h3>
       <img src="mag_stats.png" width="100%"/>
 
       <h3> Observation Info </h3>
+
+      <p>
+        These are all observations of this star.Rows marked red are observations that failed to
+        process.
+      </p>
+
       <table  class="table table-hover">
         <tr>
           <th data-toggle="tooltip" data-placement="top" title="OBSID"> OBSID </th>

agasc/supplement/magnitudes/update_mag_supplement.py

@@ -733,10 +733,14 @@ def do(
                 updated_stars["mag_aca_err"] != 0
             )
             sections = [
-                {"id": "new_stars", "title": "New Stars", "stars": new_stars},
+                {"id": "new_stars", "title": "New Stars", "description": "", "stars": new_stars},
                 {
                     "id": "updated_stars",
                     "title": "Updated Stars",
+                    "description": """
+                        Stars with updated magnitudes. Magnitudes are updated only if the absolute
+                        change is larger than 0.01 mag.
+                    """,
                     "stars": (
                         updated_stars["agasc_id"][updt_mag].tolist()
                         if len(updated_stars[updt_mag])
@@ -746,6 +750,10 @@ def do(
                 {
                     "id": "not_updated_stars",
                     "title": "Magnitude not Updated",
+                    "description": """
+                        Stars that are not updated. Magnitudes are updated only if the absolute
+                        change is larger than 0.01 mag.
+                    """,
                     "stars": (
                         updated_stars["agasc_id"][~updt_mag].tolist()
                         if len(updated_stars[~updt_mag])
@@ -755,6 +763,11 @@ def do(
                 {
                     "id": "other_stars",
                     "title": "Other (unexpectedly not updated)",
+                    "description": """
+                        Stars that were observed in the time range but something
+                        prevented them from being included in the supplement. This normally does
+                        not happen and might indicate a problem that should be investigated.
+                    """,
                     "stars": list(
                         agasc_stats["agasc_id"][
                             ~np.in1d(agasc_stats["agasc_id"], new_stars)