How to Create a Data Request IOR - Revision history

Daniel.ryan at 12:06, 18 June 2024

2024-06-18T12:06:39Z

Daniel.ryan at 10:08, 18 June 2024

2024-06-18T10:08:14Z

Daniel.ryan at 10:07, 18 June 2024

2024-06-18T10:07:27Z

Daniel.ryan at 10:03, 18 June 2024

2024-06-18T10:03:46Z

Hualin at 09:55, 18 June 2024

2024-06-18T09:55:55Z

Hualin at 09:53, 18 June 2024

2024-06-18T09:53:18Z

Hualin at 09:49, 18 June 2024

2024-06-18T09:49:19Z

Hualin: /* Data Request IOR Criteria */

2024-06-18T09:47:03Z

‎Data Request IOR Criteria

Hualin: /* Important Background Information */

2024-06-18T09:45:08Z

‎Important Background Information

Daniel.ryan at 12:07, 23 August 2023

2023-08-23T12:07:35Z

@@ Line 58: / Line 58: @@
 ** Wait times for subsequent groups must give enough time for all requests in the previous group to be downloaded.  Estimating this time is difficult.  It is safest to leave the wait time as +8hrs (default).  If you have several groups and/or if the STIX Analysis window is short, this may need to be reduced.
 ** Delays between L4 spectrogram requests aren't important.  They will be queued.  These can be left at 10 seconds.
 * Once all data request wait times have been edited, convert them to absolute times clicking "Request" -> "Delta to Absolute"
 * Click Load JSON

@@ Line 51: / Line 51: @@
 * Open [[STIX-Starlet]].
 * Prepare the IOR up until the point of adding sequences/telecommand as outlined in [[How to Create an IOR|How To Generate an IOR]].
-* Load in the data request JSON file by clicking purple "open json" button at the right end of the toolbar. If you already have commands in the IOR, click the telecommand after which the data requests should be inserted.
+* Load in the data request JSON file by clicking purple "open json" button at the right end of the toolbar. If you already have commands in the IOR, click the telecommand after which the data requests should be inserted and then click the purple json button.
 ** The JSON file will group data requests based on common detector and pixel masks.  The first two commands of the group will set the detector and pixel masks, respectively.  Subsequent commands will correspond to data requests.
 * To process data requests, STIX must be in Nominal mode.  Confirm that STIX will be in of the mode when the STIX analysis window starts.  This is usually determined by the IOR sent at the start of the STP which power cycles the instrument.  If it isn't, add a command at the start of the IOR changing the mode.

@@ Line 51: / Line 51: @@
 * Open [[STIX-Starlet]].
 * Prepare the IOR up until the point of adding sequences/telecommand as outlined in [[How to Create an IOR|How To Generate an IOR]].
-* Load in the data request JSON file by clicking yellow "open json" button at the right end of the toolbar.
+* Load in the data request JSON file by clicking purple "open json" button at the right end of the toolbar. If you already have commands in the IOR, click the telecommand after which the data requests should be inserted.
 ** The JSON file will group data requests based on common detector and pixel masks.  The first two commands of the group will set the detector and pixel masks, respectively.  Subsequent commands will correspond to data requests.
 * To process data requests, STIX must be in Nominal mode.  Confirm that STIX will be in of the mode when the STIX analysis window starts.  This is usually determined by the IOR sent at the start of the STP which power cycles the instrument.  If it isn't, add a command at the start of the IOR changing the mode.

@@ Line 45: / Line 45: @@
 **** Data requests can be manually added/removed by checking/unchecking the tick boxes.
 **** The telemetry can be found in SOOPKitchen by hovering your cursor of the STIX Analysis window.
-*** "Export" the list by clicking "Export".  This will save the list as a JSON.  Save it in the location you are using to build the IOR.
+*** "Export" the list by clicking "Export".  If the button is not visible, double click the word "manager" near the top of the page.  This will save the list as a JSON.  Save it in the location you are using to build the IOR.
 ==== Building the IOR ====

@@ Line 53: / Line 53: @@
 * Load in the data request JSON file by clicking yellow "open json" button at the right end of the toolbar.
 ** The JSON file will group data requests based on common detector and pixel masks.  The first two commands of the group will set the detector and pixel masks, respectively.  Subsequent commands will correspond to data requests.
-* To process data requests, STIX must be in Configuration or Nominal mode.  Confirm that STIX will be in of these modes when the STIX analysis window starts.  This is usually determined by the IOR sent at the start of the STP which power cycles the instrument.  If it isn't, add a command at the start of the IOR changing the mode.
+* To process data requests, STIX must be in Nominal mode.  Confirm that STIX will be in of the mode when the STIX analysis window starts.  This is usually determined by the IOR sent at the start of the STP which power cycles the instrument.  If it isn't, add a command at the start of the IOR changing the mode.
 * Edit the wait times
-** The default wait time between each group is +8 hrs.  This needs to be changed for the first group to 2 seconds.
+** The default wait time between each group is +8 hrs.  This needs to be increased if they are too many requests in the previous group
 ** Wait times for subsequent groups must give enough time for all requests in the previous group to be downloaded.  Estimating this time is difficult.  It is safest to leave the wait time as +8hrs (default).  If you have several groups and/or if the STIX Analysis window is short, this may need to be reduced.
 ** Delays between L4 spectrogram requests aren't important.  They will be queued.  These can be left at 10 seconds.

@@ Line 42: / Line 42: @@
 **** The number of data requests is limited to <300 by the daily telecommand limit of 300.  Although each data request is one telecommand, additional telecommands are needed to faciliate the data requests which are automatically generated when the data requests are exports as a JSON.  See below.
 *** Ensure the total data volume (QL estimated) is equal to the telemetry budget.  This may require manually including/excluding some larger data requests.  But be mindful of the 300 telecommand limit.
 **** Data requests can be manually added/removed by checking/unchecking the tick boxes.
 **** The telemetry can be found in SOOPKitchen by hovering your cursor of the STIX Analysis window.

@@ Line 31: / Line 31: @@
 ==== Retrieving the Data Requests ====
 * Confirm no other IORs are sending commands during the STIX analysis window.
-* Export the data requests from the STIX Data Center as a JSON file.  There are two API options, URL or website:
+* Export the data requests from the STIX Data Center as a JSON file:
 *** Go to [https://pub023.cs.technik.fhnw.ch/internal/ Expert User section of the STIX website].  On the left side bar click "Operations" followed by "Data Request Manager".  (Or go directly by clicking [https://pub023.cs.technik.fhnw.ch/view/user-data-requests/list here].)  This gives a table of all data requests.
 *** Click the "Load pending requests" button.  Unless there is a specific reason, use the default values in the pop-up window and click "OK".  This filters the list to only pending data requests (i.e. those not already in an IOR that has been uploaded to the STIX server).

@@ Line 9: / Line 9: @@
 * '''The total number to telecommands in a single 24 hour period must be less than 300.'''  This includes any other IORs that send commands on the same day.  However, this limit is not always a hard one.  Sometimes ESA does accept slightly more than 300 telecommands in a single day.
 * '''The total data volume of the requests must be within the telemetry budget defined for the STIX Analysis Window.''' This will be recorded on [[SOOP Kitchen]] for the given analysis window.
 While the telemetry budget should not be exceeded, current algorithms tend to over-estimate the data volume of data request IORs.  Moreover, it is important not to waste telemetry as we can not utilized unused telemetry budget afterwards.  It is therefore important to use as much of the budget as possible.

@@ Line 17: / Line 17: @@
 * '''Processed''': The data request has been included in an IOR on the STIX Data Center server, but the data has not yet received.  This could be because the IOR has not been sent to STIX.  Or the IOR has been sent but the data has not yet been received by the STIX Data Center server.
 * '''Pending''': The data request has been successfully saved to the STIX Data Center server, but has not yet been included in an IOR by the STIX operators.
 === Relationship to Other IORs ===