From fcc4c20cb2dd4d143a67e9609eb23874d2ef372c Mon Sep 17 00:00:00 2001 From: Steve Pothier Date: Mon, 23 Dec 2024 11:37:56 -0700 Subject: [PATCH] update notes to users --- notebooks_tsqr/NightLog.ipynb | 29 ++++++++--------------------- 1 file changed, 8 insertions(+), 21 deletions(-) diff --git a/notebooks_tsqr/NightLog.ipynb b/notebooks_tsqr/NightLog.ipynb index d6041ee..a35a80a 100644 --- a/notebooks_tsqr/NightLog.ipynb +++ b/notebooks_tsqr/NightLog.ipynb @@ -10,26 +10,22 @@ "\n", "## What is new in this application?(newest changes at top of list)\n", "- Stakeholders decided that supported instruments will be: LSSTComCam, LSSTCam, and LATISS. Of those, LSSTCam is not supported in ConsDB and limitations in LATISS will force some of the requested fields for ExposureDetail to be given as NA.\n", - "- Various minor, mostly cosmetic changes.\n", + "- Various minor, mostly cosmetic changes to: Night Report, Almanac, Time Accounting, Data Log, ExposureDetail (drill down page from Data Log)\n", "- Removed Consolidated Database section. Most of it is in ExposureDetail linked to from Data Log.\n", - "- Added optional WARNING behavior to alert when no records are found, instruments are excluded from results, etc.\n", + "- Added optional WARNING behavior to alert when no records are found, instruments are excluded from results, etc. See \"warning\" parameter in left sidebar to enable/disable it.\n", "- Name change of this page to *Nightly Digest* (but name in Times Square url remains the same)\n", "- Added Merged time-log with compaction. Merges all sources by time and compacts them into summary time periods (currently 4 hour). Rendering of DataFrame done via HTMLTemplate which gives much greater (unrealized) control over display. \n", - "- Add section for \"Links to related resources\". Let us know is other links should be added.\n", - "- Exposure quality flag added to Exposure Detail (accessed by following row links in Data Log)\n", "- \n", "- Embedded comments and questions to reader (Yellow background)\n", "- Errors from APIs are displayed in this page (Red background).\n", "\n", "## Tips\n", - "- Using \"Copy URL\" from you browser on the sections it the Table Of Contents will allow you to save a bookmark to a particular section. \n", + "- Use \"Copy URL\" from your browser on the sections in the Table Of Contents to save a bookmark to a particular section. \n", "\n", "## Changes being considered in the near-term\n", "You can influence prorities by telling #ts-logging that a feature is *really important* or *not important*.\n", "- Distinguish between errors in report and errors/warnings from Night Digest code. (How? Color coding? Something else?)\n", - "- Ensure all data-logs include data from Dome noon to noon for day_obs\n", - "- (Big Stretch) Create a single time-log that merges records from all selected *Source Adapters* into a *compacted* log. Allow delta like \"20min\", \"4hour\".\n", - "- (Realy Big Stretch) Using AI LLM to summarize a multi-source merged night of logging into: a. full summary, b. dark-time/light-time summaries, c. 4-hr summaries" + "- Ensure all data-logs include data from Dome noon to noon for day_obs" ] }, { @@ -193,7 +189,7 @@ " - Simonyi\n", "* [Summary plots of whole night (DRAFT)](#Summary-plots-of-whole-night-DRAFT)\n", "* [Links to related resources (BETA)](#Links-to-related-resources-BETA)\n", - "* [Time Accounting (DRAFT)](#Time-Accounting-DRAFT)\n", + "* [Time Accounting (DRAFT)](#Time-Accounting-BETA)\n", "* [Jira Tickets (BETA)](#Jira-Tickets-BETA)\n", " - AuxTel\n", " - Simonyi\n", @@ -211,9 +207,7 @@ "id": "9", "metadata": {}, "source": [ - "## Almanac BETA \n", - "#### Possible Changes\n", - "- [x] Add column for Chile timezone?" + "## Almanac BETA " ] }, { @@ -234,8 +228,7 @@ "source": [ "## Night Report BETA \n", "#### Possible Changes\n", - "- [ ] Word wrap instead of chopping words at end of line?\n", - "- [ ] Add summary from AI -- *REJECTED*" + "- [ ] " ] }, { @@ -484,14 +477,10 @@ "This merges the time-line of records from several sources (currently: `NightReport`, `ExposureLog`, `NarrativeLog`, `Almanac`). The resulting DataFrame is Compacted and Reduced into time bins of a specified duration.\n", "\n", "#### Possible Changes\n", - "- [ ] Column specific width (and formatting in general)\n", "- [ ] ALERT in column 1: function of regular expression in messages (e.g.: fail, error)\n", "- [ ] Truncate very log messages. End truncated messages with \"(MORE...)\"\n", "- [ ] Add multi-index columns (Level-0=Source, Level-1=Field)\n", "- [ ] Link \"Source\" in multi-index to the external-to-Logging API that provided our data.\n", - "- [x] Replace multiple rows in a period with a single row. And ...\n", - "- [x] In Period: Replace multi-values in a column with a conctenation of the unique values.\n", - "- [x] Use Jinja2 Template to render DataFrame as HTML for much better formatting control\n", "- [ ] Add TOC for integrated time log for quick access to Period or sections of text.\n", "- [ ] Include date in list of messages. Group them by period." ] @@ -530,9 +519,7 @@ { "cell_type": "markdown", "id": "35", - "metadata": { - "jp-MarkdownHeadingCollapsed": true - }, + "metadata": {}, "source": [ "# Developer Only Section REMOVE\n", "Contains stuff only expected to be useful to developers.\n",