https://pub023.cs.technik.fhnw.ch/wiki/api.php?action=feedcontributions&feedformat=atom&user=Hualinstix - User contributions [en]2026-05-16T14:26:33ZUser contributionsMediaWiki 1.31.1https://pub023.cs.technik.fhnw.ch/wiki/index.php?title=About_Us&diff=16958About Us2026-02-04T12:01:58Z<p>Hualin: </p>
<hr />
<div>== Science team ==<br />
==== University of Applied Sciences and Arts Northwestern Switzerland (FHNW) ====<br />
* [mailto:samuel.krucker@fhnw.ch Säm Krucker (PI, Professor)]<br />
* [mailto:andrea.battaglia@fhnw.ch Andrea Battaglia (PhD student)] <br />
* [mailto:marina.battaglia@fhnw.ch Marina Battaglia (Scientist)]<br />
* [mailto:ghurford@berkeley.edu Gordon Hurford (Scientist) ]<br />
* Matej Kuhar (PhD Student)<br />
* Erica Lastufka (Scientist)<br />
* [mailto:daniel.ryan@fhnw.ch Daniel Ryan (Scientist)] <br />
* [mailto:hualin.xiao@fhnw.ch Hualin Xiao (Scientist)]<br />
<br />
==== Leibniz Institute for Astrophysics Potsdam (AIP) ====<br />
* [mailto:awarmuth@aip.de Alexander Warmuth]<br />
* [mailto:fschuller@aip.de Frederic Schuller ]<br />
<br />
==== University of Graz (Universität Graz) ====<br />
* Astrid Veronig<br />
* [mailto:ewan.dickson@uni-graz.at Ewan Dickson] <br />
* Jonas Saqri<br />
* Stefan Purkhart<br />
<br />
==== Trinity College Dublin, Ireland ====<br />
* [mailto:shane.maloney@tcd.ie Shane Maloney]<br />
<br />
==== CEA ====<br />
*[mailto:Olivier.LIMOUSIN@cea.fr Olivier.LIMOUSIN]<br />
* MEURIS Aline<br />
* Sacha Brun <br />
* Antoine Strugarek<br />
==== Poland ====<br />
* Tomek Mrozek<br />
* [mailto:js@cbk.pan.wroc.pl Janus Sylwester]<br />
<br />
==== University of Genova ====<br />
* Piana piana@dima.unige.it<br />
* Paolo Massa massa.p@dima.unige.it<br />
<br />
==== LESIA ====<br />
* Nicole Vilmer<br />
<br />
== <span id="operations"> In-flight operations team</span> ==<br />
<br />
* [mailto:samuel.krucker@fhnw.ch Säm Krucker ]<br />
* [mailto:hualin.xiao@fhnw.ch Hualin Xiao ]<br />
* [mailto:daniel.ryan@fhnw.ch Daniel Ryan]<br />
* [mailto:laszlo.etesi@fhnw.ch Laslo Etesi ]<br />
* [mailto:ewan.dickson@uni-graz.at Ewan Dickson]<br />
* [mailto:fschuller@aip.de Frederic Schuller (AIP)]<br />
*[mailto:Olivier.LIMOUSIN@cea.fr Olivier.LIMOUSIN]<br />
* [mailto:andrea.battaglia@fhnw.ch Andrea Battaglia]<br />
<br />
== Data processing pipeline and data products ==<br />
<br />
* [mailto:hualin.xiao@fhnw.ch Hualin Xiao ]<br />
* [mailto:shane.maloney@tcd.ie Shane Maloney]<br />
* [mailto:ewan.dickson@uni-graz.at Ewan Dickson] <br />
* Nicky Hochmuth<br />
<br />
== STIX data center ==<br />
* [mailto:hualin.xiao@fhnw.ch Hualin Xiao ]<br />
* Erica Lastufka <br />
* Paolo Massa massa.p@dima.unige.it<br />
* [mailto:shane.maloney@tcd.ie Shane Maloney]<br />
* [mailto:samuel.krucker@fhnw.ch Säm Krucker ]<br />
* [mailto:fschuller@aip.de Frederic Schuller (AIP)]<br />
* [mailto:andrea.battaglia@fhnw.ch Andrea Battaglia]<br />
* Nicky Hochmuth<br />
<br />
== STIX flight software ==<br />
<br />
* Laslo Etesi <br />
* Simon Felix<br />
* Nicky Hochmuth <br />
* Gordon Hurford (Algorithm)<br />
* Filip Schramka<br />
<br />
== People involved in R&D of STIX Instrument ==<br />
<br />
* Martin Bednarzik (Sensors, Paul Scherrer Institut PSI), <br />
* LIMOUSIN Olivier (CEA)<br />
* Alexander Warmuth (AIP)<br />
* Diego Casadei (2012–2018),<br />
* Oliver Grimm (2012 – 2019), <br />
* Stefan Kögl <br />
* Hans-Peter Gröbelbauer, <br />
* Linus Iseli (2012–2013),<br />
* Dino Kabosch (2012–2013), <br />
* Lucia Kleint, <br />
* Stefan Kobler (2012–2013), <br />
* Matej Kuhar,<br />
* Laurent Repond (2012-2013) , <br />
* Francesca Molendini (2016-2018),<br />
* Piotr Orleanski (2011–2015), <br />
* Schori Dominic (2012-2017, <br />
* Herbert Wiehl (2013–2017)</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=How_to_Create_an_IOR&diff=16476How to Create an IOR2024-06-18T14:06:27Z<p>Hualin: </p>
<hr />
<div>An IOR (Instrument Operations Response) is a series of instructions (telecommands) telling STIX what to do. An IOR is uploaded to STIX each STP cycle which is typically a week long. The process for uploading an IOR is as follows:<br />
# [[#Generate an IOR|Generate an IOR]];<br />
# [[#Test IOR on Ground Unit|Test IOR on Ground Unit]];<br />
# [[#Submit IOR for Internal Review|Submit IOR for Internal Review]]<br />
# [[#Submit IOR to SOC|Submit IOR to SOC]]<br />
Below focuses on article will focus on the first step, creating an IOR. For definitions of acronyms used in this page, see [[Acronyms & Definitions]].<br />
<br />
== Generate an IOR ==<br />
=== Required Software ===<br />
We suggest using STIX virtual server to generate IORs. <br />
The tutorial for logging onto the server can be found at<br />
<br />
https://v000658.fhnw.ch/index.php/s/7ADcnSNExFNPCyF<br />
<br />
If you create IORs with your local machine, you need to install starlet.<br />
<br />
* [[STIX-Starlet]]<br />
For instructions installing these packages, click on the package link above.<br />
<br />
=== How To Generate an IOR ===<br />
* Check the STP schedule on the [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/Cruise+Phase Solar Orbiter wiki]. GIVE BETTER INSTRUCTIONS ON HOW TO FIND THE RELEVANT INFO FROM THIS LINK. Take note of:<br />
** The STP number/cycle;<br />
** The deadline for IOR submission deadline to the Solar Orbiter SOC; GIVE INSTRUCTIONS ON HOW TO FIND THIS INFO IN THE TABLE VIA THE ABOVE LINK.<br />
** The onboard IOR start time (equivalent to the STP start time).<br />
* Log into [[SOOP KITCHEN]] and check whether there is an "analysis window" in the current STP. If there is an analysis window, we must include data requests as part of the IOR.<br />
** The start time, duration and end time of the STP/IOR can also be confirmed via [[SOOP KITCHEN]].<br />
* Download necessary input files. See nested bullets below. All can be found at https://pub023.cs.technik.fhnw.ch/gfts/solsoc/from_soc/ (This page is password protected. Contact Hualin at hualin.xiao@fhnw.ch to get access):<br />
** MIB:<br />
*** Check the current version number on [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/MIB+and+FOP Solar Orbiter wiki]. It is given by the "MIB Name" column.<br />
*** Ctrl+F the version number on the above pub023 web address and download.<br />
*** Unzip the file.<br />
** LTP timeline JSON file<br />
*** The JSON file contains certain info on the STP, e.g. the start and end time.<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The json file for the correct LTP must be used otherwise Startlet will not process the IOR correctly.<br />
*** There is one json per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Download latest version from the above pub023 URL. (The version here is usually the latest.)<br />
<br />
* Open [[STIX-Starlet]] and enter IOR metadata.<br />
** Set directory where IOR will be generated. Settings -> Set storage directory<br />
** Set Starlet to STIX format. Settings -> Instrument -> STIX<br />
** Make sure in IOR creation mode: Menu "Request" -> "Mode" -> "IOR" <br />
** Enter the STP number from STP schedule into STP cycle field<br />
** Add your name in author field.<br />
** Add onboard start time from the STP schedule in the start time field.<br />
** End time must be before the next STP and next IOR starts (whichever is earliest), and after all telecommands have been executed. A typical value would be 24 hours after the IOR start time.<br />
** If this is the first IOR for the current STP, set the file and version numbers to 1.<br />
*** If an IOR has to be recreated due to an issue found in review, iterate version number.<br />
*** If more the STP requires more than one distinct IOR, iterate the file number<br />
* Enter the paths of the required files:<br />
** MiB: Settings -> Set instrument Database. Then select the unzipped MIB directory.<br />
** Timeline JSON: In the JSON file input, load the timeline json file. DO NOT click "Load JSON" at this stage.<br />
** If the IOR only contains data requests, follow the steps at[https://datacenter.stix.i4ds.net/wiki/index.php?title=How_to_Create_a_Data_Request_IOR]<br />
** If there are other TCs to be included, Add telecommands via the "Add Sequence".<br />
** STIX commands are prefixed at "AIX". Enter this is in the search field at the top to filter out non-STIX sequences.<br />
** See [[IOR Tips and Tricks]] for more advice.<br />
** In particular, see [[IOR Tips and Tricks#Time of First Telecommand|Time of First Telecommand]] for when to start the first telecommand of the IOR.<br />
** To include data requests in the IOR, see the section below on [[#Including a Data Request in an IOR|Including a Data Request in an IOR]]<br />
* Once all sequences are added, click "Load JSON" button. This will assign OBS ID to all telecommands. <br />
* Generate IOR by clicking "Generate" button. This will create a .SOL file in the "storage directory" set above.<br />
<br />
== Test IOR on Ground Unit (Optional) ==<br />
<br />
* If you still have the IOR open in STIX-Starlet, save the IOR to as a <code>.tcl</code> by clicking the <code>.tcl</code> button in the toolbar.<br />
<br />
See [[Using the STIX Ground Unit#Testing an IOR with the Ground Unit|Testing an IOR with the Ground Unit]].<br />
<br />
== Submit IOR to the platform==<br />
* <b>IMPORTANT</b> Upload the IOR .SOL file by clicking the "Upload" button at https://datacenter.stix.i4ds.net/view/ior/list<br />
* If more IORs need to be created, Go back to the data request page and click "load pending requests". Follow the same procedure to generate the next IOR. Requests included the IOR will no longer appear in the pending list.<br />
<br />
* Once all IORs are created and uploaded on the platform, Email the link to the IOR overview to the STIX ops team.<br />
** The IOR overview URL can be found by locating the IOR at the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] and clicking the green button in the "Overview" column.<br />
<br />
== Submit IOR to SOC ==<br />
Once the STIX team is happy with the IOR, submit it to the SOC by doing the following before the <b>IOR delivery deadline</b>:<br />
* Generate and download an IORG zip file corresponding to the IOR to be submitted.<br />
** Find the ID of the IOR from the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] on the STIX server.<br />
** Go to https://datacenter.stix.i4ds.net/view/ior/list and click the button marked "Download" on the top right of the page.<br />
** Enter the ID of the first IOR into the start field and the ID of the last IOR to be included in the end field. Also enter the STP number and the IOR number (in most cases this is 1). Then click "Create and Download".<br />
* Send the IORG file to the SOC<br />
** You will need a server account write permissions. To get an account email Hualin at hualin.xiao@fhnw.ch or Dan Ryan at daniel.ryan@fhnw.ch<br />
** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Copy the IORG zip file to [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by opening a terminal and <code>cd</code> to the directory where you saved the IORG file above. Then type <code>sudo scp <IORG filename> <username>@147.86.8.26:~</code> where <code><IORG filename></code> is the name of the IORG file and <code><username></code> is the username of your account on the STIX GFTS server.<br />
** Login into the [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by typing <code>ssh <username>@147.86.8.26</code><br />
*** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Change permissions on the IORG file: <code>sudo chmod 777 <IORG filename></code><br />
** Move the IORG file from the home directory (where we copied it to above) to the <code>to_soc</code> directory by typing <code>sudo cp ~/<IORG filename> /home/solsoc/to_soc/</code><br />
* Confirm the SOC has validated the IOR<br />
** The SOC will copy the file from the <code>to_soc</code> and then delete it. This can happen straight away. The SOC will then run an automatically verify the IOR and then return a <code>.CRR</code> back to the <code>/home/solsoc/from_soc</code> directory within 10 minutes.<br />
** <code>cd</code> to the <code>home/solsoc/from_soc</code> and wait for the <code>.CRR</code> to appear. It will have the same filename as the submitted IORG file, but with a <code>.CRR</code> extension.<br />
** Once the file has arrived, log out of the server.<br />
** Copy the <code>.CRR</code> file to your local machine by typing: <code>scp <username>@147.86.8.26:/home/solsoc/from_soc/<IORG filename> /local/folder/</code> where <code>/local/folder/</code> is the location on your local machine where the file should be copied.<br />
** Unzip the <code>.CRR</code> and open it with a text editor.<br />
** Search for the <validity> tag and confirm the message says "Valid".<br />
*** If the .CRR file reports "Valid", then we are done!<br />
*** If it is not valid, more details of the errors will be listed. Create a new version of the IOR (remembering to iterate the version number) that fixes those errors and resubmit.<br />
<br />
== Including a Data Request in an IOR ==<br />
See [[How to Create a Data Request IOR]]</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=How_to_Create_an_IOR&diff=16475How to Create an IOR2024-06-18T14:06:11Z<p>Hualin: </p>
<hr />
<div>An IOR (Instrument Operations Response) is a series of instructions (telecommands) telling STIX what to do. An IOR is uploaded to STIX each STP cycle which is typically a week long. The process for uploading an IOR is as follows:<br />
# [[#Generate an IOR|Generate an IOR]];<br />
# [[#Test IOR on Ground Unit|Test IOR on Ground Unit]];<br />
# [[#Submit IOR for Internal Review|Submit IOR for Internal Review]]<br />
# [[#Submit IOR to SOC|Submit IOR to SOC]]<br />
Below focuses on article will focus on the first step, creating an IOR. For definitions of acronyms used in this page, see [[Acronyms & Definitions]].<br />
<br />
== Generate an IOR ==<br />
=== Required Software ===<br />
We suggest using STIX virtual server to generate IORs. <br />
The tutorial for logging onto the server can be found at<br />
<br />
https://v000658.fhnw.ch/index.php/s/7ADcnSNExFNPCyF<br />
<br />
If you create IORs with your local machine, you need to install starlet.<br />
<br />
* [[STIX-Starlet]]<br />
For instructions installing these packages, click on the package link above.<br />
<br />
=== How To Generate an IOR ===<br />
* Check the STP schedule on the [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/Cruise+Phase Solar Orbiter wiki]. GIVE BETTER INSTRUCTIONS ON HOW TO FIND THE RELEVANT INFO FROM THIS LINK. Take note of:<br />
** The STP number/cycle;<br />
** The deadline for IOR submission deadline to the Solar Orbiter SOC; GIVE INSTRUCTIONS ON HOW TO FIND THIS INFO IN THE TABLE VIA THE ABOVE LINK.<br />
** The onboard IOR start time (equivalent to the STP start time).<br />
* Log into [[SOOP KITCHEN]] and check whether there is an "analysis window" in the current STP. If there is an analysis window, we must include data requests as part of the IOR.<br />
** The start time, duration and end time of the STP/IOR can also be confirmed via [[SOOP KITCHEN]].<br />
* Download necessary input files. See nested bullets below. All can be found at https://pub023.cs.technik.fhnw.ch/gfts/solsoc/from_soc/ (This page is password protected. Contact Hualin at hualin.xiao@fhnw.ch to get access):<br />
** MIB:<br />
*** Check the current version number on [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/MIB+and+FOP Solar Orbiter wiki]. It is given by the "MIB Name" column.<br />
*** Ctrl+F the version number on the above pub023 web address and download.<br />
*** Unzip the file.<br />
** LTP timeline JSON file<br />
*** The JSON file contains certain info on the STP, e.g. the start and end time.<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The json file for the correct LTP must be used otherwise Startlet will not process the IOR correctly.<br />
*** There is one json per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Download latest version from the above pub023 URL. (The version here is usually the latest.)<br />
<br />
* Open [[STIX-Starlet]] and enter IOR metadata.<br />
** Set directory where IOR will be generated. Settings -> Set storage directory<br />
** Set Starlet to STIX format. Settings -> Instrument -> STIX<br />
** Make sure in IOR creation mode: Menu "Request" -> "Mode" -> "IOR" <br />
** Enter the STP number from STP schedule into STP cycle field<br />
** Add your name in author field.<br />
** Add onboard start time from the STP schedule in the start time field.<br />
** End time must be before the next STP and next IOR starts (whichever is earliest), and after all telecommands have been executed. A typical value would be 24 hours after the IOR start time.<br />
** If this is the first IOR for the current STP, set the file and version numbers to 1.<br />
*** If an IOR has to be recreated due to an issue found in review, iterate version number.<br />
*** If more the STP requires more than one distinct IOR, iterate the file number<br />
* Enter the paths of the required files:<br />
** MiB: Settings -> Set instrument Database. Then select the unzipped MIB directory.<br />
** Timeline JSON: In the JSON file input, load the timeline json file. DO NOT click "Load JSON" at this stage.<br />
** If the IOR only contains data requests, follow the steps at[https://datacenter.stix.i4ds.net/wiki/index.php?title=How_to_Create_a_Data_Request_IOR]<br />
** If there are other TCs to be included, Add telecommands via the "Add Sequence".<br />
** STIX commands are prefixed at "AIX". Enter this is in the search field at the top to filter out non-STIX sequences.<br />
** See [[IOR Tips and Tricks]] for more advice.<br />
** In particular, see [[IOR Tips and Tricks#Time of First Telecommand|Time of First Telecommand]] for when to start the first telecommand of the IOR.<br />
** To include data requests in the IOR, see the section below on [[#Including a Data Request in an IOR|Including a Data Request in an IOR]]<br />
* Once all sequences are added, click "Load JSON" button. This will assign OBS ID to all telecommands. <br />
* Generate IOR by clicking "Generate" button. This will create a .SOL file in the "storage directory" set above.<br />
<br />
== Test IOR on Ground Unit (Optional) ==<br />
<br />
* If you still have the IOR open in STIX-Starlet, save the IOR to as a <code>.tcl</code> by clicking the <code>.tcl</code> button in the toolbar.<br />
<br />
See [[Using the STIX Ground Unit#Testing an IOR with the Ground Unit|Testing an IOR with the Ground Unit]].<br />
<br />
== Submit IOR to the platform==<br />
* <b>IMPORTANT</b> Upload the IOR .SOL file by clicking the "Upload" button at https://datacenter.stix.i4ds.net/view/ior/list<br />
* If more IORs need to be created, Go back to the data request page and click "load pending requests". <br />
Follow the same procedure to generate the next IOR. Requests included the IOR will no longer appear in the pending list.<br />
<br />
<br />
* Once all IORs are created and uploaded on the platform, Email the link to the IOR overview to the STIX ops team.<br />
** The IOR overview URL can be found by locating the IOR at the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] and clicking the green button in the "Overview" column.<br />
<br />
== Submit IOR to SOC ==<br />
Once the STIX team is happy with the IOR, submit it to the SOC by doing the following before the <b>IOR delivery deadline</b>:<br />
* Generate and download an IORG zip file corresponding to the IOR to be submitted.<br />
** Find the ID of the IOR from the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] on the STIX server.<br />
** Go to https://datacenter.stix.i4ds.net/view/ior/list and click the button marked "Download" on the top right of the page.<br />
** Enter the ID of the first IOR into the start field and the ID of the last IOR to be included in the end field. Also enter the STP number and the IOR number (in most cases this is 1). Then click "Create and Download".<br />
* Send the IORG file to the SOC<br />
** You will need a server account write permissions. To get an account email Hualin at hualin.xiao@fhnw.ch or Dan Ryan at daniel.ryan@fhnw.ch<br />
** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Copy the IORG zip file to [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by opening a terminal and <code>cd</code> to the directory where you saved the IORG file above. Then type <code>sudo scp <IORG filename> <username>@147.86.8.26:~</code> where <code><IORG filename></code> is the name of the IORG file and <code><username></code> is the username of your account on the STIX GFTS server.<br />
** Login into the [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by typing <code>ssh <username>@147.86.8.26</code><br />
*** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Change permissions on the IORG file: <code>sudo chmod 777 <IORG filename></code><br />
** Move the IORG file from the home directory (where we copied it to above) to the <code>to_soc</code> directory by typing <code>sudo cp ~/<IORG filename> /home/solsoc/to_soc/</code><br />
* Confirm the SOC has validated the IOR<br />
** The SOC will copy the file from the <code>to_soc</code> and then delete it. This can happen straight away. The SOC will then run an automatically verify the IOR and then return a <code>.CRR</code> back to the <code>/home/solsoc/from_soc</code> directory within 10 minutes.<br />
** <code>cd</code> to the <code>home/solsoc/from_soc</code> and wait for the <code>.CRR</code> to appear. It will have the same filename as the submitted IORG file, but with a <code>.CRR</code> extension.<br />
** Once the file has arrived, log out of the server.<br />
** Copy the <code>.CRR</code> file to your local machine by typing: <code>scp <username>@147.86.8.26:/home/solsoc/from_soc/<IORG filename> /local/folder/</code> where <code>/local/folder/</code> is the location on your local machine where the file should be copied.<br />
** Unzip the <code>.CRR</code> and open it with a text editor.<br />
** Search for the <validity> tag and confirm the message says "Valid".<br />
*** If the .CRR file reports "Valid", then we are done!<br />
*** If it is not valid, more details of the errors will be listed. Create a new version of the IOR (remembering to iterate the version number) that fixes those errors and resubmit.<br />
<br />
== Including a Data Request in an IOR ==<br />
See [[How to Create a Data Request IOR]]</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=How_to_Create_an_IOR&diff=16474How to Create an IOR2024-06-18T14:03:50Z<p>Hualin: </p>
<hr />
<div>An IOR (Instrument Operations Response) is a series of instructions (telecommands) telling STIX what to do. An IOR is uploaded to STIX each STP cycle which is typically a week long. The process for uploading an IOR is as follows:<br />
# [[#Generate an IOR|Generate an IOR]];<br />
# [[#Test IOR on Ground Unit|Test IOR on Ground Unit]];<br />
# [[#Submit IOR for Internal Review|Submit IOR for Internal Review]]<br />
# [[#Submit IOR to SOC|Submit IOR to SOC]]<br />
Below focuses on article will focus on the first step, creating an IOR. For definitions of acronyms used in this page, see [[Acronyms & Definitions]].<br />
<br />
== Generate an IOR ==<br />
=== Required Software ===<br />
We suggest using STIX virtual server to generate IORs. <br />
The tutorial for logging onto the server can be found at<br />
<br />
https://v000658.fhnw.ch/index.php/s/7ADcnSNExFNPCyF<br />
<br />
If you create IORs with your local machine, you need to install starlet.<br />
<br />
* [[STIX-Starlet]]<br />
For instructions installing these packages, click on the package link above.<br />
<br />
=== How To Generate an IOR ===<br />
* Check the STP schedule on the [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/Cruise+Phase Solar Orbiter wiki]. GIVE BETTER INSTRUCTIONS ON HOW TO FIND THE RELEVANT INFO FROM THIS LINK. Take note of:<br />
** The STP number/cycle;<br />
** The deadline for IOR submission deadline to the Solar Orbiter SOC; GIVE INSTRUCTIONS ON HOW TO FIND THIS INFO IN THE TABLE VIA THE ABOVE LINK.<br />
** The onboard IOR start time (equivalent to the STP start time).<br />
* Log into [[SOOP KITCHEN]] and check whether there is an "analysis window" in the current STP. If there is an analysis window, we must include data requests as part of the IOR.<br />
** The start time, duration and end time of the STP/IOR can also be confirmed via [[SOOP KITCHEN]].<br />
* Download necessary input files. See nested bullets below. All can be found at https://pub023.cs.technik.fhnw.ch/gfts/solsoc/from_soc/ (This page is password protected. Contact Hualin at hualin.xiao@fhnw.ch to get access):<br />
** MIB:<br />
*** Check the current version number on [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/MIB+and+FOP Solar Orbiter wiki]. It is given by the "MIB Name" column.<br />
*** Ctrl+F the version number on the above pub023 web address and download.<br />
*** Unzip the file.<br />
** LTP timeline JSON file<br />
*** The JSON file contains certain info on the STP, e.g. the start and end time.<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The json file for the correct LTP must be used otherwise Startlet will not process the IOR correctly.<br />
*** There is one json per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Download latest version from the above pub023 URL. (The version here is usually the latest.)<br />
<br />
* Open [[STIX-Starlet]] and enter IOR metadata.<br />
** Set directory where IOR will be generated. Settings -> Set storage directory<br />
** Set Starlet to STIX format. Settings -> Instrument -> STIX<br />
** Make sure in IOR creation mode: Menu "Request" -> "Mode" -> "IOR" <br />
** Enter the STP number from STP schedule into STP cycle field<br />
** Add your name in author field.<br />
** Add onboard start time from the STP schedule in the start time field.<br />
** End time must be before the next STP and next IOR starts (whichever is earliest), and after all telecommands have been executed. A typical value would be 24 hours after the IOR start time.<br />
** If this is the first IOR for the current STP, set the file and version numbers to 1.<br />
*** If an IOR has to be recreated due to an issue found in review, iterate version number.<br />
*** If more the STP requires more than one distinct IOR, iterate the file number<br />
* Enter the paths of the required files:<br />
** MiB: Settings -> Set instrument Database. Then select the unzipped MIB directory.<br />
** Timeline JSON: In the JSON file input, load the timeline json file. DO NOT click "Load JSON" at this stage.<br />
** If the IOR only contains data requests, follow the steps at[https://datacenter.stix.i4ds.net/wiki/index.php?title=How_to_Create_a_Data_Request_IOR]<br />
** If there are other TCs to be included, Add telecommands via the "Add Sequence".<br />
** STIX commands are prefixed at "AIX". Enter this is in the search field at the top to filter out non-STIX sequences.<br />
** See [[IOR Tips and Tricks]] for more advice.<br />
** In particular, see [[IOR Tips and Tricks#Time of First Telecommand|Time of First Telecommand]] for when to start the first telecommand of the IOR.<br />
** To include data requests in the IOR, see the section below on [[#Including a Data Request in an IOR|Including a Data Request in an IOR]]<br />
* Once all sequences are added, click "Load JSON" button. This will assign OBS ID to all telecommands. <br />
* Generate IOR by clicking "Generate" button. This will create a .SOL file in the "storage directory" set above.<br />
<br />
== Test IOR on Ground Unit (Optional) ==<br />
<br />
* If you still have the IOR open in STIX-Starlet, save the IOR to as a <code>.tcl</code> by clicking the <code>.tcl</code> button in the toolbar.<br />
<br />
See [[Using the STIX Ground Unit#Testing an IOR with the Ground Unit|Testing an IOR with the Ground Unit]].<br />
<br />
== Submit IOR to the platform==<br />
* Upload IOR .SOL file by clicking the "Upload" button at https://datacenter.stix.i4ds.net/view/ior/list<br />
* <b>IMPORTANT</b>: Goto the data request page and click "load pending requests". Follow the same procedure to generate the next IOR. Requests included the IOR will no longer appear in the pending list.<br />
<br />
* Once all IORs are created and uploaded on the platform, Email the link to the IOR overview to the STIX ops team.<br />
** The IOR overview URL can be found by locating the IOR at the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] and clicking the green button in the "Overview" column.<br />
<br />
== Submit IOR to SOC ==<br />
Once the STIX team is happy with the IOR, submit it to the SOC by doing the following before the <b>IOR delivery deadline</b>:<br />
* Generate and download an IORG zip file corresponding to the IOR to be submitted.<br />
** Find the ID of the IOR from the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] on the STIX server.<br />
** Go to https://datacenter.stix.i4ds.net/view/ior/list and click the button marked "Download" on the top right of the page.<br />
** Enter the ID of the first IOR into the start field and the ID of the last IOR to be included in the end field. Also enter the STP number and the IOR number (in most cases this is 1). Then click "Create and Download".<br />
* Send the IORG file to the SOC<br />
** You will need a server account write permissions. To get an account email Hualin at hualin.xiao@fhnw.ch or Dan Ryan at daniel.ryan@fhnw.ch<br />
** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Copy the IORG zip file to [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by opening a terminal and <code>cd</code> to the directory where you saved the IORG file above. Then type <code>sudo scp <IORG filename> <username>@147.86.8.26:~</code> where <code><IORG filename></code> is the name of the IORG file and <code><username></code> is the username of your account on the STIX GFTS server.<br />
** Login into the [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by typing <code>ssh <username>@147.86.8.26</code><br />
*** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Change permissions on the IORG file: <code>sudo chmod 777 <IORG filename></code><br />
** Move the IORG file from the home directory (where we copied it to above) to the <code>to_soc</code> directory by typing <code>sudo cp ~/<IORG filename> /home/solsoc/to_soc/</code><br />
* Confirm the SOC has validated the IOR<br />
** The SOC will copy the file from the <code>to_soc</code> and then delete it. This can happen straight away. The SOC will then run an automatically verify the IOR and then return a <code>.CRR</code> back to the <code>/home/solsoc/from_soc</code> directory within 10 minutes.<br />
** <code>cd</code> to the <code>home/solsoc/from_soc</code> and wait for the <code>.CRR</code> to appear. It will have the same filename as the submitted IORG file, but with a <code>.CRR</code> extension.<br />
** Once the file has arrived, log out of the server.<br />
** Copy the <code>.CRR</code> file to your local machine by typing: <code>scp <username>@147.86.8.26:/home/solsoc/from_soc/<IORG filename> /local/folder/</code> where <code>/local/folder/</code> is the location on your local machine where the file should be copied.<br />
** Unzip the <code>.CRR</code> and open it with a text editor.<br />
** Search for the <validity> tag and confirm the message says "Valid".<br />
*** If the .CRR file reports "Valid", then we are done!<br />
*** If it is not valid, more details of the errors will be listed. Create a new version of the IOR (remembering to iterate the version number) that fixes those errors and resubmit.<br />
<br />
== Including a Data Request in an IOR ==<br />
See [[How to Create a Data Request IOR]]</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=How_to_Create_an_IOR&diff=16473How to Create an IOR2024-06-18T14:03:32Z<p>Hualin: </p>
<hr />
<div>An IOR (Instrument Operations Response) is a series of instructions (telecommands) telling STIX what to do. An IOR is uploaded to STIX each STP cycle which is typically a week long. The process for uploading an IOR is as follows:<br />
# [[#Generate an IOR|Generate an IOR]];<br />
# [[#Test IOR on Ground Unit|Test IOR on Ground Unit]];<br />
# [[#Submit IOR for Internal Review|Submit IOR for Internal Review]]<br />
# [[#Submit IOR to SOC|Submit IOR to SOC]]<br />
Below focuses on article will focus on the first step, creating an IOR. For definitions of acronyms used in this page, see [[Acronyms & Definitions]].<br />
<br />
== Generate an IOR ==<br />
=== Required Software ===<br />
We suggest using STIX virtual server to generate IORs. <br />
The tutorial for logging onto the server can be found at<br />
<br />
https://v000658.fhnw.ch/index.php/s/7ADcnSNExFNPCyF<br />
<br />
If you create IORs with your local machine, you need to install starlet.<br />
<br />
* [[STIX-Starlet]]<br />
For instructions installing these packages, click on the package link above.<br />
<br />
=== How To Generate an IOR ===<br />
* Check the STP schedule on the [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/Cruise+Phase Solar Orbiter wiki]. GIVE BETTER INSTRUCTIONS ON HOW TO FIND THE RELEVANT INFO FROM THIS LINK. Take note of:<br />
** The STP number/cycle;<br />
** The deadline for IOR submission deadline to the Solar Orbiter SOC; GIVE INSTRUCTIONS ON HOW TO FIND THIS INFO IN THE TABLE VIA THE ABOVE LINK.<br />
** The onboard IOR start time (equivalent to the STP start time).<br />
* Log into [[SOOP KITCHEN]] and check whether there is an "analysis window" in the current STP. If there is an analysis window, we must include data requests as part of the IOR.<br />
** The start time, duration and end time of the STP/IOR can also be confirmed via [[SOOP KITCHEN]].<br />
* Download necessary input files. See nested bullets below. All can be found at https://pub023.cs.technik.fhnw.ch/gfts/solsoc/from_soc/ (This page is password protected. Contact Hualin at hualin.xiao@fhnw.ch to get access):<br />
** MIB:<br />
*** Check the current version number on [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/MIB+and+FOP Solar Orbiter wiki]. It is given by the "MIB Name" column.<br />
*** Ctrl+F the version number on the above pub023 web address and download.<br />
*** Unzip the file.<br />
** LTP timeline JSON file<br />
*** The JSON file contains certain info on the STP, e.g. the start and end time.<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The json file for the correct LTP must be used otherwise Startlet will not process the IOR correctly.<br />
*** There is one json per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Download latest version from the above pub023 URL. (The version here is usually the latest.)<br />
<br />
* Open [[STIX-Starlet]] and enter IOR metadata.<br />
** Set directory where IOR will be generated. Settings -> Set storage directory<br />
** Set Starlet to STIX format. Settings -> Instrument -> STIX<br />
** Make sure in IOR creation mode: Menu "Request" -> "Mode" -> "IOR" <br />
** Enter the STP number from STP schedule into STP cycle field<br />
** Add your name in author field.<br />
** Add onboard start time from the STP schedule in the start time field.<br />
** End time must be before the next STP and next IOR starts (whichever is earliest), and after all telecommands have been executed. A typical value would be 24 hours after the IOR start time.<br />
** If this is the first IOR for the current STP, set the file and version numbers to 1.<br />
*** If an IOR has to be recreated due to an issue found in review, iterate version number.<br />
*** If more the STP requires more than one distinct IOR, iterate the file number<br />
* Enter the paths of the required files:<br />
** MiB: Settings -> Set instrument Database. Then select the unzipped MIB directory.<br />
** Timeline JSON: In the JSON file input, load the timeline json file. DO NOT click "Load JSON" at this stage.<br />
** If the IOR only contains data requests, follow the steps at[https://datacenter.stix.i4ds.net/wiki/index.php?title=How_to_Create_a_Data_Request_IOR]<br />
** If there are other TCs to be included, Add telecommands via the "Add Sequence".<br />
** STIX commands are prefixed at "AIX". Enter this is in the search field at the top to filter out non-STIX sequences.<br />
** See [[IOR Tips and Tricks]] for more advice.<br />
** In particular, see [[IOR Tips and Tricks#Time of First Telecommand|Time of First Telecommand]] for when to start the first telecommand of the IOR.<br />
** To include data requests in the IOR, see the section below on [[#Including a Data Request in an IOR|Including a Data Request in an IOR]]<br />
* Once all sequences are added, click "Load JSON" button. This will assign OBS ID to all telecommands. <br />
* Generate IOR by clicking "Generate" button. This will create a .SOL file in the "storage directory" set above.<br />
<br />
== Test IOR on Ground Unit (Optional) ==<br />
<br />
* If you still have the IOR open in STIX-Starlet, save the IOR to as a <code>.tcl</code> by clicking the <code>.tcl</code> button in the toolbar.<br />
<br />
See [[Using the STIX Ground Unit#Testing an IOR with the Ground Unit|Testing an IOR with the Ground Unit]].<br />
<br />
== Submit IOR to the platform==<br />
* Upload IOR .SOL file by clicking the "Upload" button at https://datacenter.stix.i4ds.net/view/ior/list<br />
* <b>IMPORTANT</b>: Goto the data request page and click "load pending requests". Follow the same procedure to generate the next IOR. <br />
Requests included the IOR will no longer appear in the pending list.<br />
<br />
* Once all IORs are created and uploaded on the platform, Email the link to the IOR overview to the STIX ops team.<br />
** The IOR overview URL can be found by locating the IOR at the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] and clicking the green button in the "Overview" column.<br />
<br />
== Submit IOR to SOC ==<br />
Once the STIX team is happy with the IOR, submit it to the SOC by doing the following before the <b>IOR delivery deadline</b>:<br />
* Generate and download an IORG zip file corresponding to the IOR to be submitted.<br />
** Find the ID of the IOR from the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] on the STIX server.<br />
** Go to https://datacenter.stix.i4ds.net/view/ior/list and click the button marked "Download" on the top right of the page.<br />
** Enter the ID of the first IOR into the start field and the ID of the last IOR to be included in the end field. Also enter the STP number and the IOR number (in most cases this is 1). Then click "Create and Download".<br />
* Send the IORG file to the SOC<br />
** You will need a server account write permissions. To get an account email Hualin at hualin.xiao@fhnw.ch or Dan Ryan at daniel.ryan@fhnw.ch<br />
** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Copy the IORG zip file to [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by opening a terminal and <code>cd</code> to the directory where you saved the IORG file above. Then type <code>sudo scp <IORG filename> <username>@147.86.8.26:~</code> where <code><IORG filename></code> is the name of the IORG file and <code><username></code> is the username of your account on the STIX GFTS server.<br />
** Login into the [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by typing <code>ssh <username>@147.86.8.26</code><br />
*** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Change permissions on the IORG file: <code>sudo chmod 777 <IORG filename></code><br />
** Move the IORG file from the home directory (where we copied it to above) to the <code>to_soc</code> directory by typing <code>sudo cp ~/<IORG filename> /home/solsoc/to_soc/</code><br />
* Confirm the SOC has validated the IOR<br />
** The SOC will copy the file from the <code>to_soc</code> and then delete it. This can happen straight away. The SOC will then run an automatically verify the IOR and then return a <code>.CRR</code> back to the <code>/home/solsoc/from_soc</code> directory within 10 minutes.<br />
** <code>cd</code> to the <code>home/solsoc/from_soc</code> and wait for the <code>.CRR</code> to appear. It will have the same filename as the submitted IORG file, but with a <code>.CRR</code> extension.<br />
** Once the file has arrived, log out of the server.<br />
** Copy the <code>.CRR</code> file to your local machine by typing: <code>scp <username>@147.86.8.26:/home/solsoc/from_soc/<IORG filename> /local/folder/</code> where <code>/local/folder/</code> is the location on your local machine where the file should be copied.<br />
** Unzip the <code>.CRR</code> and open it with a text editor.<br />
** Search for the <validity> tag and confirm the message says "Valid".<br />
*** If the .CRR file reports "Valid", then we are done!<br />
*** If it is not valid, more details of the errors will be listed. Create a new version of the IOR (remembering to iterate the version number) that fixes those errors and resubmit.<br />
<br />
== Including a Data Request in an IOR ==<br />
See [[How to Create a Data Request IOR]]</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=How_to_Create_an_IOR&diff=16472How to Create an IOR2024-06-18T13:58:19Z<p>Hualin: </p>
<hr />
<div>An IOR (Instrument Operations Response) is a series of instructions (telecommands) telling STIX what to do. An IOR is uploaded to STIX each STP cycle which is typically a week long. The process for uploading an IOR is as follows:<br />
# [[#Generate an IOR|Generate an IOR]];<br />
# [[#Test IOR on Ground Unit|Test IOR on Ground Unit]];<br />
# [[#Submit IOR for Internal Review|Submit IOR for Internal Review]]<br />
# [[#Submit IOR to SOC|Submit IOR to SOC]]<br />
Below focuses on article will focus on the first step, creating an IOR. For definitions of acronyms used in this page, see [[Acronyms & Definitions]].<br />
<br />
== Generate an IOR ==<br />
=== Required Software ===<br />
We suggest using STIX virtual server to generate IORs. <br />
The tutorial for logging onto the server can be found at<br />
<br />
https://v000658.fhnw.ch/index.php/s/7ADcnSNExFNPCyF<br />
<br />
If you create IORs with your local machine, you need to install starlet.<br />
<br />
* [[STIX-Starlet]]<br />
For instructions installing these packages, click on the package link above.<br />
<br />
=== How To Generate an IOR ===<br />
* Check the STP schedule on the [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/Cruise+Phase Solar Orbiter wiki]. GIVE BETTER INSTRUCTIONS ON HOW TO FIND THE RELEVANT INFO FROM THIS LINK. Take note of:<br />
** The STP number/cycle;<br />
** The deadline for IOR submission deadline to the Solar Orbiter SOC; GIVE INSTRUCTIONS ON HOW TO FIND THIS INFO IN THE TABLE VIA THE ABOVE LINK.<br />
** The onboard IOR start time (equivalent to the STP start time).<br />
* Log into [[SOOP KITCHEN]] and check whether there is an "analysis window" in the current STP. If there is an analysis window, we must include data requests as part of the IOR.<br />
** The start time, duration and end time of the STP/IOR can also be confirmed via [[SOOP KITCHEN]].<br />
* Download necessary input files. See nested bullets below. All can be found at https://pub023.cs.technik.fhnw.ch/gfts/solsoc/from_soc/ (This page is password protected. Contact Hualin at hualin.xiao@fhnw.ch to get access):<br />
** MIB:<br />
*** Check the current version number on [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/MIB+and+FOP Solar Orbiter wiki]. It is given by the "MIB Name" column.<br />
*** Ctrl+F the version number on the above pub023 web address and download.<br />
*** Unzip the file.<br />
** LTP timeline JSON file<br />
*** The JSON file contains certain info on the STP, e.g. the start and end time.<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The json file for the correct LTP must be used otherwise Startlet will not process the IOR correctly.<br />
*** There is one json per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Download latest version from the above pub023 URL. (The version here is usually the latest.)<br />
<br />
* Open [[STIX-Starlet]] and enter IOR metadata.<br />
** Set directory where IOR will be generated. Settings -> Set storage directory<br />
** Set Starlet to STIX format. Settings -> Instrument -> STIX<br />
** Make sure in IOR creation mode: Menu "Request" -> "Mode" -> "IOR" <br />
** Enter the STP number from STP schedule into STP cycle field<br />
** Add your name in author field.<br />
** Add onboard start time from the STP schedule in the start time field.<br />
** End time must be before the next STP and next IOR starts (whichever is earliest), and after all telecommands have been executed. A typical value would be 24 hours after the IOR start time.<br />
** If this is the first IOR for the current STP, set the file and version numbers to 1.<br />
*** If an IOR has to be recreated due to an issue found in review, iterate version number.<br />
*** If more the STP requires more than one distinct IOR, iterate the file number<br />
* Enter the paths of the required files:<br />
** MiB: Settings -> Set instrument Database. Then select the unzipped MIB directory.<br />
** Timeline JSON: In the JSON file input, load the timeline json file. DO NOT click "Load JSON" at this stage.<br />
** If the IOR only contains data requests, follow the steps at[https://datacenter.stix.i4ds.net/wiki/index.php?title=How_to_Create_a_Data_Request_IOR]<br />
** If there are other TCs to be included, Add telecommands via the "Add Sequence".<br />
** STIX commands are prefixed at "AIX". Enter this is in the search field at the top to filter out non-STIX sequences.<br />
** See [[IOR Tips and Tricks]] for more advice.<br />
** In particular, see [[IOR Tips and Tricks#Time of First Telecommand|Time of First Telecommand]] for when to start the first telecommand of the IOR.<br />
** To include data requests in the IOR, see the section below on [[#Including a Data Request in an IOR|Including a Data Request in an IOR]]<br />
* Once all sequences are added, click "Load JSON" button. This will assign OBS ID to all telecommands. <br />
* Generate IOR by clicking "Generate" button. This will create a .SOL file in the "storage directory" set above.<br />
<br />
== Test IOR on Ground Unit (Optional) ==<br />
<br />
* If you still have the IOR open in STIX-Starlet, save the IOR to as a <code>.tcl</code> by clicking the <code>.tcl</code> button in the toolbar.<br />
<br />
See [[Using the STIX Ground Unit#Testing an IOR with the Ground Unit|Testing an IOR with the Ground Unit]].<br />
<br />
== Submit IOR for Internal Review ==<br />
* Upload IOR .SOL file by clicking the "Upload" button at https://datacenter.stix.i4ds.net/view/ior/list<br />
* Email the link to the IOR overview to the STIX ops team.<br />
** The IOR overview URL can be found by locating the IOR at the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] and clicking the green button in the "Overview" column.<br />
<br />
== Submit IOR to SOC ==<br />
Once the STIX team is happy with the IOR, submit it to the SOC by doing the following before the <b>IOR delivery deadline</b>:<br />
* Generate and download an IORG zip file corresponding to the IOR to be submitted.<br />
** Find the ID of the IOR from the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] on the STIX server.<br />
** Go to https://datacenter.stix.i4ds.net/view/ior/list and click the button marked "Download" on the top right of the page.<br />
** Enter the ID of the first IOR into the start field and the ID of the last IOR to be included in the end field. Also enter the STP number and the IOR number (in most cases this is 1). Then click "Create and Download".<br />
* Send the IORG file to the SOC<br />
** You will need a server account write permissions. To get an account email Hualin at hualin.xiao@fhnw.ch or Dan Ryan at daniel.ryan@fhnw.ch<br />
** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Copy the IORG zip file to [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by opening a terminal and <code>cd</code> to the directory where you saved the IORG file above. Then type <code>sudo scp <IORG filename> <username>@147.86.8.26:~</code> where <code><IORG filename></code> is the name of the IORG file and <code><username></code> is the username of your account on the STIX GFTS server.<br />
** Login into the [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by typing <code>ssh <username>@147.86.8.26</code><br />
*** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Change permissions on the IORG file: <code>sudo chmod 777 <IORG filename></code><br />
** Move the IORG file from the home directory (where we copied it to above) to the <code>to_soc</code> directory by typing <code>sudo cp ~/<IORG filename> /home/solsoc/to_soc/</code><br />
* Confirm the SOC has validated the IOR<br />
** The SOC will copy the file from the <code>to_soc</code> and then delete it. This can happen straight away. The SOC will then run an automatically verify the IOR and then return a <code>.CRR</code> back to the <code>/home/solsoc/from_soc</code> directory within 10 minutes.<br />
** <code>cd</code> to the <code>home/solsoc/from_soc</code> and wait for the <code>.CRR</code> to appear. It will have the same filename as the submitted IORG file, but with a <code>.CRR</code> extension.<br />
** Once the file has arrived, log out of the server.<br />
** Copy the <code>.CRR</code> file to your local machine by typing: <code>scp <username>@147.86.8.26:/home/solsoc/from_soc/<IORG filename> /local/folder/</code> where <code>/local/folder/</code> is the location on your local machine where the file should be copied.<br />
** Unzip the <code>.CRR</code> and open it with a text editor.<br />
** Search for the <validity> tag and confirm the message says "Valid".<br />
*** If the .CRR file reports "Valid", then we are done!<br />
*** If it is not valid, more details of the errors will be listed. Create a new version of the IOR (remembering to iterate the version number) that fixes those errors and resubmit.<br />
<br />
== Including a Data Request in an IOR ==<br />
See [[How to Create a Data Request IOR]]</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=How_to_Create_an_IOR&diff=16471How to Create an IOR2024-06-18T13:57:11Z<p>Hualin: </p>
<hr />
<div>An IOR (Instrument Operations Response) is a series of instructions (telecommands) telling STIX what to do. An IOR is uploaded to STIX each STP cycle which is typically a week long. The process for uploading an IOR is as follows:<br />
# [[#Generate an IOR|Generate an IOR]];<br />
# [[#Test IOR on Ground Unit|Test IOR on Ground Unit]];<br />
# [[#Submit IOR for Internal Review|Submit IOR for Internal Review]]<br />
# [[#Submit IOR to SOC|Submit IOR to SOC]]<br />
Below focuses on article will focus on the first step, creating an IOR. For definitions of acronyms used in this page, see [[Acronyms & Definitions]].<br />
<br />
== Generate an IOR ==<br />
=== Required Software ===<br />
We suggest using STIX virtual server to generate IORs. <br />
The tutorial for logging onto the server can be found at<br />
<br />
https://v000658.fhnw.ch/index.php/s/7ADcnSNExFNPCyF<br />
<br />
If you create IORs with your local machine, you need to install starlet.<br />
<br />
* [[STIX-Starlet]]<br />
For instructions installing these packages, click on the package link above.<br />
<br />
=== How To Generate an IOR ===<br />
* Check the STP schedule on the [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/Cruise+Phase Solar Orbiter wiki]. GIVE BETTER INSTRUCTIONS ON HOW TO FIND THE RELEVANT INFO FROM THIS LINK. Take note of:<br />
** The STP number/cycle;<br />
** The deadline for IOR submission deadline to the Solar Orbiter SOC; GIVE INSTRUCTIONS ON HOW TO FIND THIS INFO IN THE TABLE VIA THE ABOVE LINK.<br />
** The onboard IOR start time (equivalent to the STP start time).<br />
* Log into [[SOOP KITCHEN]] and check whether there is an "analysis window" in the current STP. If there is an analysis window, we must include data requests as part of the IOR.<br />
** The start time, duration and end time of the STP/IOR can also be confirmed via [[SOOP KITCHEN]].<br />
* Download necessary input files. See nested bullets below. All can be found at https://pub023.cs.technik.fhnw.ch/gfts/solsoc/from_soc/ (This page is password protected. Contact Hualin at hualin.xiao@fhnw.ch to get access):<br />
** MIB:<br />
*** Check the current version number on [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/MIB+and+FOP Solar Orbiter wiki]. It is given by the "MIB Name" column.<br />
*** Ctrl+F the version number on the above pub023 web address and download.<br />
*** Unzip the file.<br />
** LTP timeline JSON file<br />
*** The JSON file contains certain info on the STP, e.g. the start and end time.<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The json file for the correct LTP must be used otherwise Startlet will not process the IOR correctly.<br />
*** There is one json per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Download latest version from the above pub023 URL. (The version here is usually the latest.)<br />
<br />
* Open [[STIX-Starlet]] and enter IOR metadata.<br />
** Set directory where IOR will be generated. Settings -> Set storage directory<br />
** Set Starlet to STIX format. Settings -> Instrument -> STIX<br />
** Make sure in IOR creation mode: Menu "Request" -> "Mode" -> "IOR" <br />
** Enter the STP number from STP schedule into STP cycle field<br />
** Add your name in author field.<br />
** Add onboard start time from the STP schedule in the start time field.<br />
** End time must be before the next STP and next IOR starts (whichever is earliest), and after all telecommands have been executed. A typical value would be 24 hours after the IOR start time.<br />
** If this is the first IOR for the current STP, set the file and version numbers to 1.<br />
*** If an IOR has to be recreated due to an issue found in review, iterate version number.<br />
*** If more the STP requires more than one distinct IOR, iterate the file number<br />
* Enter the paths of the required files:<br />
** MiB: Settings -> Set instrument Database. Then select the unzipped MIB directory.<br />
** Timeline JSON: In the JSON file input, load the timeline json file. DO NOT click "Load JSON" at this stage.<br />
** If the IOR only contains data requests, follow the steps at[https://datacenter.stix.i4ds.net/wiki/index.php?title=How_to_Create_a_Data_Request_IOR]<br />
** If there are other TCs to be included, Add telecommands via the "Add Sequence".<br />
** STIX commands are prefixed at "AIX". Enter this is in the search field at the top to filter out non-STIX sequences.<br />
** See [[IOR Tips and Tricks]] for more advice.<br />
** In particular, see [[IOR Tips and Tricks#Time of First Telecommand|Time of First Telecommand]] for when to start the first telecommand of the IOR.<br />
** To include data requests in the IOR, see the section below on [[#Including a Data Request in an IOR|Including a Data Request in an IOR]]<br />
* Once all sequences are added, click "Load JSON" button. This will assign OBS ID to all telecommands. <br />
* Generate IOR by clicking "Generate" button. This will create a .SOL file in the "storage directory" set above.<br />
<br />
== Test IOR on Ground Unit (Optional) ==<br />
<br />
* If you still have the IOR open in STIX-Starlet, save the IOR to as a <code>.tcl</code> by clicking the <code>.tcl</code> button in the toolbar.<br />
<br />
See [[Using the STIX Ground Unit#Testing an IOR with the Ground Unit|Testing an IOR with the Ground Unit]].<br />
<br />
== Submit IOR for Internal Review ==<br />
* Upload IOR .SOL file by clicking the "Upload IOR" button at https://pub023.cs.technik.fhnw.ch/view/operations<br />
* Email the link to the IOR overview to the STIX ops team.<br />
** The IOR overview URL can be found by locating the IOR at the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] and clicking the green button in the "Overview" column.<br />
<br />
== Submit IOR to SOC ==<br />
Once the STIX team is happy with the IOR, submit it to the SOC by doing the following before the <b>IOR delivery deadline</b>:<br />
* Generate and download an IORG zip file corresponding to the IOR to be submitted.<br />
** Find the ID of the IOR from the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] on the STIX server.<br />
** Go to https://datacenter.stix.i4ds.net/view/ior/list and click the button marked "Download" on the top right of the page.<br />
** Enter the ID of the first IOR into the start field and the ID of the last IOR to be included in the end field. Also enter the STP number and the IOR number (in most cases this is 1). Then click "Create and Download".<br />
* Send the IORG file to the SOC<br />
** You will need a server account write permissions. To get an account email Hualin at hualin.xiao@fhnw.ch or Dan Ryan at daniel.ryan@fhnw.ch<br />
** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Copy the IORG zip file to [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by opening a terminal and <code>cd</code> to the directory where you saved the IORG file above. Then type <code>sudo scp <IORG filename> <username>@147.86.8.26:~</code> where <code><IORG filename></code> is the name of the IORG file and <code><username></code> is the username of your account on the STIX GFTS server.<br />
** Login into the [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by typing <code>ssh <username>@147.86.8.26</code><br />
*** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Change permissions on the IORG file: <code>sudo chmod 777 <IORG filename></code><br />
** Move the IORG file from the home directory (where we copied it to above) to the <code>to_soc</code> directory by typing <code>sudo cp ~/<IORG filename> /home/solsoc/to_soc/</code><br />
* Confirm the SOC has validated the IOR<br />
** The SOC will copy the file from the <code>to_soc</code> and then delete it. This can happen straight away. The SOC will then run an automatically verify the IOR and then return a <code>.CRR</code> back to the <code>/home/solsoc/from_soc</code> directory within 10 minutes.<br />
** <code>cd</code> to the <code>home/solsoc/from_soc</code> and wait for the <code>.CRR</code> to appear. It will have the same filename as the submitted IORG file, but with a <code>.CRR</code> extension.<br />
** Once the file has arrived, log out of the server.<br />
** Copy the <code>.CRR</code> file to your local machine by typing: <code>scp <username>@147.86.8.26:/home/solsoc/from_soc/<IORG filename> /local/folder/</code> where <code>/local/folder/</code> is the location on your local machine where the file should be copied.<br />
** Unzip the <code>.CRR</code> and open it with a text editor.<br />
** Search for the <validity> tag and confirm the message says "Valid".<br />
*** If the .CRR file reports "Valid", then we are done!<br />
*** If it is not valid, more details of the errors will be listed. Create a new version of the IOR (remembering to iterate the version number) that fixes those errors and resubmit.<br />
<br />
== Including a Data Request in an IOR ==<br />
See [[How to Create a Data Request IOR]]</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=How_to_Create_an_IOR&diff=16470How to Create an IOR2024-06-18T13:26:40Z<p>Hualin: </p>
<hr />
<div>An IOR (Instrument Operations Response) is a series of instructions (telecommands) telling STIX what to do. An IOR is uploaded to STIX each STP cycle which is typically a week long. The process for uploading an IOR is as follows:<br />
# [[#Generate an IOR|Generate an IOR]];<br />
# [[#Test IOR on Ground Unit|Test IOR on Ground Unit]];<br />
# [[#Submit IOR for Internal Review|Submit IOR for Internal Review]]<br />
# [[#Submit IOR to SOC|Submit IOR to SOC]]<br />
Below focuses on article will focus on the first step, creating an IOR. For definitions of acronyms used in this page, see [[Acronyms & Definitions]].<br />
<br />
== Generate an IOR ==<br />
=== Required Software ===<br />
We suggest using STIX virtual server to generate IORs. <br />
The tutorial for logging onto the server can be found at<br />
<br />
https://v000658.fhnw.ch/index.php/s/7ADcnSNExFNPCyF<br />
<br />
If you create IORs with your local machine, you need to install starlet.<br />
<br />
* [[STIX-Starlet]]<br />
For instructions installing these packages, click on the package link above.<br />
<br />
=== How To Generate an IOR ===<br />
* Check the STP schedule on the [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/Cruise+Phase Solar Orbiter wiki]. GIVE BETTER INSTRUCTIONS ON HOW TO FIND THE RELEVANT INFO FROM THIS LINK. Take note of:<br />
** The STP number/cycle;<br />
** The deadline for IOR submission deadline to the Solar Orbiter SOC; GIVE INSTRUCTIONS ON HOW TO FIND THIS INFO IN THE TABLE VIA THE ABOVE LINK.<br />
** The onboard IOR start time (equivalent to the STP start time).<br />
* Log into [[SOOP KITCHEN]] and check whether there is an "analysis window" in the current STP. If there is an analysis window, we must include data requests as part of the IOR.<br />
** The start time, duration and end time of the STP/IOR can also be confirmed via [[SOOP KITCHEN]].<br />
* Download necessary input files. See nested bullets below. All can be found at https://pub023.cs.technik.fhnw.ch/gfts/solsoc/from_soc/ (This page is password protected. Contact Hualin at hualin.xiao@fhnw.ch to get access):<br />
** MIB:<br />
*** Check the current version number on [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/MIB+and+FOP Solar Orbiter wiki]. It is given by the "MIB Name" column.<br />
*** Ctrl+F the version number on the above pub023 web address and download.<br />
*** Unzip the file.<br />
** LTP timeline JSON file<br />
*** The JSON file contains certain info on the STP, e.g. the start and end time.<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The json file for the correct LTP must be used otherwise Startlet will not process the IOR correctly.<br />
*** There is one json per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Download latest version from the above pub023 URL. (The version here is usually the latest.)<br />
<br />
* Open [[STIX-Starlet]] and enter IOR metadata.<br />
** Set directory where IOR will be generated. Settings -> Set storage directory<br />
** Set Starlet to STIX format. Settings -> Instrument -> STIX<br />
** Make sure in IOR creation mode: Menu "Request" -> "Mode" -> "IOR" <br />
** Enter the STP number from STP schedule into STP cycle field<br />
** Add your name in author field.<br />
** Add onboard start time from the STP schedule in the start time field.<br />
** End time must be before the next STP and next IOR starts (whichever is earliest), and after all telecommands have been executed. A typical value would be 24 hours after the IOR start time.<br />
** If this is the first IOR for the current STP, set the file and version numbers to 1.<br />
*** If an IOR has to be recreated due to an issue found in review, iterate version number.<br />
*** If more the STP requires more than one distinct IOR, iterate the file number<br />
* Enter the paths of the required files:<br />
** MiB: Settings -> Set instrument Database. Then select the unzipped MIB directory.<br />
** Timeline JSON: In the JSON file input, load the timeline json file. DO NOT click "Load JSON" at this stage.<br />
** If the IOR only contains data requests, follow the steps at[https://datacenter.stix.i4ds.net/wiki/index.php?title=How_to_Create_a_Data_Request_IOR]<br />
** If there are other TCs to be included, Add telecommands via the "Add Sequence".<br />
** STIX commands are prefixed at "AIX". Enter this is in the search field at the top to filter out non-STIX sequences.<br />
** See [[IOR Tips and Tricks]] for more advice.<br />
** In particular, see [[IOR Tips and Tricks#Time of First Telecommand|Time of First Telecommand]] for when to start the first telecommand of the IOR.<br />
** To include data requests in the IOR, see the section below on [[#Including a Data Request in an IOR|Including a Data Request in an IOR]]<br />
* Once all sequences are added, click "Load JSON" button. This will assign OBS ID to all telecommands. <br />
* Generate IOR by clicking "Generate" button. This will create a .SOL file in the "storage directory" set above.<br />
<br />
== Test IOR on Ground Unit (Optional) ==<br />
<br />
* If you still have the IOR open in STIX-Starlet, save the IOR to as a <code>.tcl</code> by clicking the <code>.tcl</code> button in the toolbar.<br />
<br />
See [[Using the STIX Ground Unit#Testing an IOR with the Ground Unit|Testing an IOR with the Ground Unit]].<br />
<br />
== Submit IOR for Internal Review ==<br />
* Upload IOR .SOL file by clicking the "Upload IOR" button at https://pub023.cs.technik.fhnw.ch/view/operations<br />
* Email the link to the IOR overview to the STIX ops team.<br />
** The IOR overview URL can be found by locating the IOR at the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] and clicking the green button in the "Overview" column.<br />
<br />
== Submit IOR to SOC ==<br />
Once the STIX team is happy with the IOR, submit it to the SOC by doing the following before the <b>IOR delivery deadline</b>:<br />
* Generate and download an IORG zip file corresponding to the IOR to be submitted.<br />
** Find the ID of the IOR from the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] on the STIX server.<br />
** Go to https://pub023.cs.technik.fhnw.ch/view/operations and click the button marked "Create IORG File".<br />
** Enter the ID of the first IOR into the start field and the ID of the last IOR to be included in the end field. Also enter the STP number and the IOR number (in most cases this is 1). Then click "Create and Download".<br />
* Send the IORG file to the SOC<br />
** You will need a server account write permissions. To get an account email Hualin at hualin.xiao@fhnw.ch or Dan Ryan at daniel.ryan@fhnw.ch<br />
** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Copy the IORG zip file to [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by opening a terminal and <code>cd</code> to the directory where you saved the IORG file above. Then type <code>sudo scp <IORG filename> <username>@147.86.8.26:~</code> where <code><IORG filename></code> is the name of the IORG file and <code><username></code> is the username of your account on the STIX GFTS server.<br />
** Login into the [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by typing <code>ssh <username>@147.86.8.26</code><br />
*** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Change permissions on the IORG file: <code>sudo chmod 777 <IORG filename></code><br />
** Move the IORG file from the home directory (where we copied it to above) to the <code>to_soc</code> directory by typing <code>sudo cp ~/<IORG filename> /home/solsoc/to_soc/</code><br />
* Confirm the SOC has validated the IOR<br />
** The SOC will copy the file from the <code>to_soc</code> and then delete it. This can happen straight away. The SOC will then run an automatically verify the IOR and then return a <code>.CRR</code> back to the <code>/home/solsoc/from_soc</code> directory within 10 minutes.<br />
** <code>cd</code> to the <code>home/solsoc/from_soc</code> and wait for the <code>.CRR</code> to appear. It will have the same filename as the submitted IORG file, but with a <code>.CRR</code> extension.<br />
** Once the file has arrived, log out of the server.<br />
** Copy the <code>.CRR</code> file to your local machine by typing: <code>scp <username>@147.86.8.26:/home/solsoc/from_soc/<IORG filename> /local/folder/</code> where <code>/local/folder/</code> is the location on your local machine where the file should be copied.<br />
** Unzip the <code>.CRR</code> and open it with a text editor.<br />
** Search for the <validity> tag and confirm the message says "Valid".<br />
*** If the .CRR file reports "Valid", then we are done!<br />
*** If it is not valid, more details of the errors will be listed. Create a new version of the IOR (remembering to iterate the version number) that fixes those errors and resubmit.<br />
<br />
== Including a Data Request in an IOR ==<br />
See [[How to Create a Data Request IOR]]</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=How_to_Create_an_IOR&diff=16469How to Create an IOR2024-06-18T13:20:36Z<p>Hualin: </p>
<hr />
<div>An IOR (Instrument Operations Response) is a series of instructions (telecommands) telling STIX what to do. An IOR is uploaded to STIX each STP cycle which is typically a week long. The process for uploading an IOR is as follows:<br />
# [[#Generate an IOR|Generate an IOR]];<br />
# [[#Test IOR on Ground Unit|Test IOR on Ground Unit]];<br />
# [[#Submit IOR for Internal Review|Submit IOR for Internal Review]]<br />
# [[#Submit IOR to SOC|Submit IOR to SOC]]<br />
Below focuses on article will focus on the first step, creating an IOR. For definitions of acronyms used in this page, see [[Acronyms & Definitions]].<br />
<br />
== Generate an IOR ==<br />
=== Required Software ===<br />
We suggest using STIX virtual server to generate IORs. <br />
The tutorial for logging onto the server can be found at<br />
<br />
https://v000658.fhnw.ch/index.php/s/7ADcnSNExFNPCyF<br />
<br />
If you create IORs with your local machine, you need to install starlet.<br />
<br />
* [[STIX-Starlet]]<br />
For instructions installing these packages, click on the package link above.<br />
<br />
=== How To Generate an IOR ===<br />
* Check the STP schedule on the [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/Cruise+Phase Solar Orbiter wiki]. GIVE BETTER INSTRUCTIONS ON HOW TO FIND THE RELEVANT INFO FROM THIS LINK. Take note of:<br />
** The STP number/cycle;<br />
** The deadline for IOR submission deadline to the Solar Orbiter SOC; GIVE INSTRUCTIONS ON HOW TO FIND THIS INFO IN THE TABLE VIA THE ABOVE LINK.<br />
** The onboard IOR start time (equivalent to the STP start time).<br />
* Log into [[SOOP KITCHEN]] and check whether there is an "analysis window" in the current STP. If there is an analysis window, we must include data requests as part of the IOR.<br />
** The start time, duration and end time of the STP/IOR can also be confirmed via [[SOOP KITCHEN]].<br />
* Download necessary input files. See nested bullets below. All can be found at https://pub023.cs.technik.fhnw.ch/gfts/solsoc/from_soc/ (This page is password protected. Contact Hualin at hualin.xiao@fhnw.ch to get access):<br />
** MIB:<br />
*** Check the current version number on [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/MIB+and+FOP Solar Orbiter wiki]. It is given by the "MIB Name" column.<br />
*** Ctrl+F the version number on the above pub023 web address and download.<br />
*** Unzip the file.<br />
** LTP timeline JSON file<br />
*** The JSON file contains certain info on the STP, e.g. the start and end time.<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The json file for the correct LTP must be used otherwise Startlet will not process the IOR correctly.<br />
*** There is one json per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Download latest version from the above pub023 URL. (The version here is usually the latest.)<br />
** EFECS<br />
**TMC<br />
* Open [[STIX-Starlet]] and enter IOR metadata.<br />
** Set directory where IOR will be generated. Settings -> Set storage directory<br />
** Set Starlet to STIX format. Settings -> Instrument -> STIX<br />
** Make sure in IOR creation mode: Menu "Request" -> "Mode" -> "IOR" <br />
** Enter the STP number from STP schedule into STP cycle field<br />
** Add your name in author field.<br />
** Add onboard start time from the STP schedule in the start time field.<br />
** End time must be before the next STP and next IOR starts (whichever is earliest), and after all telecommands have been executed. A typical value would be 24 hours after the IOR start time.<br />
** If this is the first IOR for the current STP, set the file and version numbers to 1.<br />
*** If an IOR has to be recreated due to an issue found in review, iterate version number.<br />
*** If more the STP requires more than one distinct IOR, iterate the file number<br />
* Enter the paths of the required files:<br />
** MiB: Settings -> Set instrument Database. Then select the unzipped MIB directory.<br />
** Timeline JSON: In the JSON file input, load the timeline json file. DO NOT click "Load JSON" at this stage.<br />
* Add telecommands via the "Add Sequence".<br />
** STIX commands are prefixed at "AIX". Enter this is in the search field at the top to filter out non-STIX sequences.<br />
** See [[IOR Tips and Tricks]] for more advice.<br />
** In particular, see [[IOR Tips and Tricks#Time of First Telecommand|Time of First Telecommand]] for when to start the first telecommand of the IOR.<br />
** To include data requests in the IOR, see the section below on [[#Including a Data Request in an IOR|Including a Data Request in an IOR]]<br />
* Once all sequences are added, click "Load JSON" button. This will assign OBS ID to all telecommands. <br />
* Generate IOR by clicking "Generate" button. This will create a .SOL file in the "storage directory" set above.<br />
<br />
== Test IOR on Ground Unit (Optional) ==<br />
<br />
* If you still have the IOR open in STIX-Starlet, save the IOR to as a <code>.tcl</code> by clicking the <code>.tcl</code> button in the toolbar.<br />
<br />
See [[Using the STIX Ground Unit#Testing an IOR with the Ground Unit|Testing an IOR with the Ground Unit]].<br />
<br />
== Submit IOR for Internal Review ==<br />
* Upload IOR .SOL file by clicking the "Upload IOR" button at https://pub023.cs.technik.fhnw.ch/view/operations<br />
* Email the link to the IOR overview to the STIX ops team.<br />
** The IOR overview URL can be found by locating the IOR at the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] and clicking the green button in the "Overview" column.<br />
<br />
== Submit IOR to SOC ==<br />
Once the STIX team is happy with the IOR, submit it to the SOC by doing the following before the <b>IOR delivery deadline</b>:<br />
* Generate and download an IORG zip file corresponding to the IOR to be submitted.<br />
** Find the ID of the IOR from the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] on the STIX server.<br />
** Go to https://pub023.cs.technik.fhnw.ch/view/operations and click the button marked "Create IORG File".<br />
** Enter the ID of the first IOR into the start field and the ID of the last IOR to be included in the end field. Also enter the STP number and the IOR number (in most cases this is 1). Then click "Create and Download".<br />
* Send the IORG file to the SOC<br />
** You will need a server account write permissions. To get an account email Hualin at hualin.xiao@fhnw.ch or Dan Ryan at daniel.ryan@fhnw.ch<br />
** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Copy the IORG zip file to [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by opening a terminal and <code>cd</code> to the directory where you saved the IORG file above. Then type <code>sudo scp <IORG filename> <username>@147.86.8.26:~</code> where <code><IORG filename></code> is the name of the IORG file and <code><username></code> is the username of your account on the STIX GFTS server.<br />
** Login into the [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by typing <code>ssh <username>@147.86.8.26</code><br />
*** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Change permissions on the IORG file: <code>sudo chmod 777 <IORG filename></code><br />
** Move the IORG file from the home directory (where we copied it to above) to the <code>to_soc</code> directory by typing <code>sudo cp ~/<IORG filename> /home/solsoc/to_soc/</code><br />
* Confirm the SOC has validated the IOR<br />
** The SOC will copy the file from the <code>to_soc</code> and then delete it. This can happen straight away. The SOC will then run an automatically verify the IOR and then return a <code>.CRR</code> back to the <code>/home/solsoc/from_soc</code> directory within 10 minutes.<br />
** <code>cd</code> to the <code>home/solsoc/from_soc</code> and wait for the <code>.CRR</code> to appear. It will have the same filename as the submitted IORG file, but with a <code>.CRR</code> extension.<br />
** Once the file has arrived, log out of the server.<br />
** Copy the <code>.CRR</code> file to your local machine by typing: <code>scp <username>@147.86.8.26:/home/solsoc/from_soc/<IORG filename> /local/folder/</code> where <code>/local/folder/</code> is the location on your local machine where the file should be copied.<br />
** Unzip the <code>.CRR</code> and open it with a text editor.<br />
** Search for the <validity> tag and confirm the message says "Valid".<br />
*** If the .CRR file reports "Valid", then we are done!<br />
*** If it is not valid, more details of the errors will be listed. Create a new version of the IOR (remembering to iterate the version number) that fixes those errors and resubmit.<br />
<br />
== Including a Data Request in an IOR ==<br />
See [[How to Create a Data Request IOR]]</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=How_to_Create_an_IOR&diff=16468How to Create an IOR2024-06-18T13:17:54Z<p>Hualin: </p>
<hr />
<div>An IOR (Instrument Operations Response) is a series of instructions (telecommands) telling STIX what to do. An IOR is uploaded to STIX each STP cycle which is typically a week long. The process for uploading an IOR is as follows:<br />
# [[#Generate an IOR|Generate an IOR]];<br />
# [[#Test IOR on Ground Unit|Test IOR on Ground Unit]];<br />
# [[#Submit IOR for Internal Review|Submit IOR for Internal Review]]<br />
# [[#Submit IOR to SOC|Submit IOR to SOC]]<br />
Below focuses on article will focus on the first step, creating an IOR. For definitions of acronyms used in this page, see [[Acronyms & Definitions]].<br />
<br />
== Generate an IOR ==<br />
=== Required Software ===<br />
We suggest using STIX virtual server to generate IORs. <br />
The tutorial for logging onto the server can be found at<br />
<br />
https://v000658.fhnw.ch/index.php/s/7ADcnSNExFNPCyF<br />
<br />
If you create IORs with your local machine, you need to install starlet.<br />
<br />
* [[STIX-Starlet]]<br />
For instructions installing these packages, click on the package link above.<br />
<br />
=== How To Generate an IOR ===<br />
* Check the STP schedule on the [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/Cruise+Phase Solar Orbiter wiki]. GIVE BETTER INSTRUCTIONS ON HOW TO FIND THE RELEVANT INFO FROM THIS LINK. Take note of:<br />
** The STP number/cycle;<br />
** The deadline for IOR submission deadline to the Solar Orbiter SOC; GIVE INSTRUCTIONS ON HOW TO FIND THIS INFO IN THE TABLE VIA THE ABOVE LINK.<br />
** The onboard IOR start time (equivalent to the STP start time).<br />
* Log into [[SOOP KITCHEN]] and check whether there is an "analysis window" in the current STP. If there is an analysis window, we must include data requests as part of the IOR.<br />
** The start time, duration and end time of the STP/IOR can also be confirmed via [[SOOP KITCHEN]].<br />
* Download necessary input files. See nested bullets below. All can be found at https://pub023.cs.technik.fhnw.ch/gfts/solsoc/from_soc/ (This page is password protected. Contact Hualin at hualin.xiao@fhnw.ch to get access):<br />
** MIB:<br />
*** Check the current version number on [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/MIB+and+FOP Solar Orbiter wiki]. It is given by the "MIB Name" column.<br />
*** Ctrl+F the version number on the above pub023 web address and download.<br />
*** Unzip the file.<br />
** LTP timeline JSON file<br />
*** The JSON file contains certain info on the STP, e.g. the start and end time.<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The json file for the correct LTP must be used otherwise Startlet will not process the IOR correctly.<br />
*** There is one json per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Download latest version from the above pub023 URL. (The version here is usually the latest.)<br />
** EFECS<br />
**TMC<br />
* Open [[STIX-Starlet]] and enter IOR metadata.<br />
** Set directory where IOR will be generated. Settings -> Set storage directory<br />
** Set Starlet to STIX format. Settings -> Instrument -> STIX<br />
** Make sure in IOR creation mode: Menu "Request" -> "Mode" -> "IOR" <br />
** Enter the STP number from STP schedule into STP cycle field<br />
** Add your name in author field.<br />
** Add onboard start time from the STP schedule in the start time field.<br />
** End time must be before the next STP and next IOR starts (whichever is earliest), and after all telecommands have been executed. A typical value would be 24 hours after the IOR start time.<br />
** If this is the first IOR for the current STP, set the file and version numbers to 1.<br />
*** If an IOR has to be recreated due to an issue found in review, iterate version number.<br />
*** If more the STP requires more than one distinct IOR, iterate the file number<br />
* Enter the paths of the required files:<br />
** MiB: Settings -> Set instrument Database. Then select the unzipped MIB directory.<br />
** Timeline JSON: Do the same as for E-FECS and TMC. DO NOT click "Load JSON" at this stage.<br />
* Add telecommands via the "Add Sequence".<br />
** STIX commands are prefixed at "AIX". Enter this is in the search field at the top to filter out non-STIX sequences.<br />
** See [[IOR Tips and Tricks]] for more advice.<br />
** In particular, see [[IOR Tips and Tricks#Time of First Telecommand|Time of First Telecommand]] for when to start the first telecommand of the IOR.<br />
** To include data requests in the IOR, see the section below on [[#Including a Data Request in an IOR|Including a Data Request in an IOR]]<br />
* Once all sequences are added, click "Load JSON" button. This will assign OBS ID to all telecommands. <br />
* Generate IOR by clicking "Generate" button. This will create a .SOL file in the "storage directory" set above.<br />
<br />
== Test IOR on Ground Unit (Optional) ==<br />
<br />
* If you still have the IOR open in STIX-Starlet, save the IOR to as a <code>.tcl</code> by clicking the <code>.tcl</code> button in the toolbar.<br />
<br />
See [[Using the STIX Ground Unit#Testing an IOR with the Ground Unit|Testing an IOR with the Ground Unit]].<br />
<br />
== Submit IOR for Internal Review ==<br />
* Upload IOR .SOL file by clicking the "Upload IOR" button at https://pub023.cs.technik.fhnw.ch/view/operations<br />
* Email the link to the IOR overview to the STIX ops team.<br />
** The IOR overview URL can be found by locating the IOR at the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] and clicking the green button in the "Overview" column.<br />
<br />
== Submit IOR to SOC ==<br />
Once the STIX team is happy with the IOR, submit it to the SOC by doing the following before the <b>IOR delivery deadline</b>:<br />
* Generate and download an IORG zip file corresponding to the IOR to be submitted.<br />
** Find the ID of the IOR from the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] on the STIX server.<br />
** Go to https://pub023.cs.technik.fhnw.ch/view/operations and click the button marked "Create IORG File".<br />
** Enter the ID of the first IOR into the start field and the ID of the last IOR to be included in the end field. Also enter the STP number and the IOR number (in most cases this is 1). Then click "Create and Download".<br />
* Send the IORG file to the SOC<br />
** You will need a server account write permissions. To get an account email Hualin at hualin.xiao@fhnw.ch or Dan Ryan at daniel.ryan@fhnw.ch<br />
** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Copy the IORG zip file to [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by opening a terminal and <code>cd</code> to the directory where you saved the IORG file above. Then type <code>sudo scp <IORG filename> <username>@147.86.8.26:~</code> where <code><IORG filename></code> is the name of the IORG file and <code><username></code> is the username of your account on the STIX GFTS server.<br />
** Login into the [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by typing <code>ssh <username>@147.86.8.26</code><br />
*** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Change permissions on the IORG file: <code>sudo chmod 777 <IORG filename></code><br />
** Move the IORG file from the home directory (where we copied it to above) to the <code>to_soc</code> directory by typing <code>sudo cp ~/<IORG filename> /home/solsoc/to_soc/</code><br />
* Confirm the SOC has validated the IOR<br />
** The SOC will copy the file from the <code>to_soc</code> and then delete it. This can happen straight away. The SOC will then run an automatically verify the IOR and then return a <code>.CRR</code> back to the <code>/home/solsoc/from_soc</code> directory within 10 minutes.<br />
** <code>cd</code> to the <code>home/solsoc/from_soc</code> and wait for the <code>.CRR</code> to appear. It will have the same filename as the submitted IORG file, but with a <code>.CRR</code> extension.<br />
** Once the file has arrived, log out of the server.<br />
** Copy the <code>.CRR</code> file to your local machine by typing: <code>scp <username>@147.86.8.26:/home/solsoc/from_soc/<IORG filename> /local/folder/</code> where <code>/local/folder/</code> is the location on your local machine where the file should be copied.<br />
** Unzip the <code>.CRR</code> and open it with a text editor.<br />
** Search for the <validity> tag and confirm the message says "Valid".<br />
*** If the .CRR file reports "Valid", then we are done!<br />
*** If it is not valid, more details of the errors will be listed. Create a new version of the IOR (remembering to iterate the version number) that fixes those errors and resubmit.<br />
<br />
== Including a Data Request in an IOR ==<br />
See [[How to Create a Data Request IOR]]</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=How_to_Create_a_Data_Request_IOR&diff=16462How to Create a Data Request IOR2024-06-18T09:55:55Z<p>Hualin: </p>
<hr />
<div>== Important Background Information ==<br />
<br />
=== What is a Data Request IOR? ===<br />
A Data Request IOR includes sets of instructions for STIX to process its observations into certain data products (e.g. L1 or L4 Spectrogram) and send them back to Earth. These instructions correspond to data requests made by the community or the STIX team. (To learn more, see [[How to Create a Data Request|What is a Data Request?]]) Data Request IORs can only be issued during STIX Analysis Windows which are scheduled and defined on [[SOOP KITCHEN]].<br />
<br />
=== Data Request IOR Criteria ===<br />
A Data Request IOR must be compiled in line with the following criteria:<br />
* '''Highest priority data requests must be included first.''' Data Requests can have three priorities: High, Medium, and Low.<br />
* '''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.<br />
* '''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.<br />
* In an STP, different slots are scheduled for different purposes: spectrograms, large science data, etc. You can get the information from STIX operations team<br />
<br />
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.<br />
<br />
=== Data Request Status ===<br />
Data Requests have one of three statuses:<br />
* '''Executed''': The requested data has been received from STIX by the STIX Data Center and is available.<br />
* '''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.<br />
* '''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.<br />
* '''Failed''': The data request has been failed onboard, due to "bulk science data not found"<br />
<br />
=== Relationship to Other IORs ===<br />
While it is possible to mix data requests with other telecommands, it is standard prcatice to create an IOR just for data requests and another for other operations telecommands. An exception might be to include non-data request telecommands that MUST be run during the STIX analysis window. This makes it easier to ensure that STIX is operating nominally during the STIX analysis window and the telecommand limit of 300/day is being used more efficiently. Therefore, IORs should not overlap in time.<br />
<br />
== Generate a Data Request IOR ==<br />
<br />
=== Required Software ===<br />
See [[How to Create an IOR|Required Software]].<br />
<br />
=== How to Generate a Data Request IOR ===<br />
==== Retrieving the Data Requests ====<br />
* Confirm no other IORs are sending commands during the STIX analysis window.<br />
* Export the data requests from the STIX Data Center as a JSON file:<br />
*** 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.<br />
*** 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).<br />
*** Access a hidden toolbar by double-clicking the word "requests" in "STIX user data requests" above the "New" button.<br />
*** Check the tickboxes for the data requests to be included. Alternatively, click "AutoSel" to automatically select <300 data requests.<br />
**** Data requests should be selected in order of highest priority.<br />
**** Within each priority level, the requests involving older data should be picked first. Note requests for older data do not always correspond to lower IDs.<br />
**** The table can be sorted according to a certain parameter by clicking on the arrows next to the column name. Depending on how many requests there are, this may take a while. The order can be reversed by clicking the same arrows again.<br />
**** Note that aspect data requests are not selected by "AutoSel" because the website software currently can't determine whether they have been processed or executed. Their status is always "Pending". So the operator must know whether specific aspect data requests should be included.<br />
**** 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.<br />
*** 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.<br />
**** Requests with identical detector mask, pixel mask, data type, and scaling factor are grouped together. Ensure not including more than 3 different groups of data requests in an IOR<br />
**** Data requests can be manually added/removed by checking/unchecking the tick boxes.<br />
**** The telemetry can be found in SOOPKitchen by hovering your cursor of the STIX Analysis window.<br />
*** "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.<br />
<br />
==== Building the IOR ====<br />
* It is typical to build an IOR specially for the data requests. If possible, other telecommands required during the STP can be put in another IOR. This IOR should be executed on a different day to the data request IOR so as not to waste the daily 300 telecommand limit. However, data request and other telecommands can be put into the same IOR if needed.<br />
* Open [[STIX-Starlet]].<br />
* Prepare the IOR up until the point of adding sequences/telecommand as outlined in [[How to Create an IOR|How To Generate an IOR]].<br />
* Load in the data request JSON file by clicking yellow "open json" button at the right end of the toolbar.<br />
** 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.<br />
* 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.<br />
* Edit the wait times<br />
** 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<br />
** 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.<br />
** Delays between L4 spectrogram requests aren't important. They will be queued. These can be left at 10 seconds.<br />
** If including an aspect data request, allow 30 minutes for each request in the wait time.<br />
* Once all data request wait times have been edited, convert them to absolute times clicking "Request" -> "Delta to Absolute"<br />
* Click Load JSON<br />
* Click Generate<br />
* Once ready, [[How to Create an IOR|Submit IOR for Internal Review]] in the usual way.<br />
* Once approved by the STIX team, [[How to Create an IOR|Submit IOR to SOC]] in the usual way.</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=How_to_Create_a_Data_Request_IOR&diff=16461How to Create a Data Request IOR2024-06-18T09:53:18Z<p>Hualin: </p>
<hr />
<div>== Important Background Information ==<br />
<br />
=== What is a Data Request IOR? ===<br />
A Data Request IOR includes sets of instructions for STIX to process its observations into certain data products (e.g. L1 or L4 Spectrogram) and send them back to Earth. These instructions correspond to data requests made by the community or the STIX team. (To learn more, see [[How to Create a Data Request|What is a Data Request?]]) Data Request IORs can only be issued during STIX Analysis Windows which are scheduled and defined on [[SOOP KITCHEN]].<br />
<br />
=== Data Request IOR Criteria ===<br />
A Data Request IOR must be compiled in line with the following criteria:<br />
* '''Highest priority data requests must be included first.''' Data Requests can have three priorities: High, Medium, and Low.<br />
* '''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.<br />
* '''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.<br />
* In an STP, different slots are scheduled for different purposes: spectrograms, large science data, etc. You can get the information from STIX operations team<br />
<br />
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.<br />
<br />
=== Data Request Status ===<br />
Data Requests have one of three statuses:<br />
* '''Executed''': The requested data has been received from STIX by the STIX Data Center and is available.<br />
* '''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.<br />
* '''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.<br />
* '''Failed''': The data request has been failed onboard, due to "bulk science data not found"<br />
<br />
=== Relationship to Other IORs ===<br />
While it is possible to mix data requests with other telecommands, it is standard prcatice to create an IOR just for data requests and another for other operations telecommands. An exception might be to include non-data request telecommands that MUST be run during the STIX analysis window. This makes it easier to ensure that STIX is operating nominally during the STIX analysis window and the telecommand limit of 300/day is being used more efficiently. Therefore, IORs should not overlap in time.<br />
<br />
== Generate a Data Request IOR ==<br />
<br />
=== Required Software ===<br />
See [[How to Create an IOR|Required Software]].<br />
<br />
=== How to Generate a Data Request IOR ===<br />
==== Retrieving the Data Requests ====<br />
* Confirm no other IORs are sending commands during the STIX analysis window.<br />
* Export the data requests from the STIX Data Center as a JSON file:<br />
*** 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.<br />
*** 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).<br />
*** Access a hidden toolbar by double-clicking the word "requests" in "STIX user data requests" above the "New" button.<br />
*** Check the tickboxes for the data requests to be included. Alternatively, click "AutoSel" to automatically select <300 data requests.<br />
**** Data requests should be selected in order of highest priority.<br />
**** Within each priority level, the requests involving older data should be picked first. Note requests for older data do not always correspond to lower IDs.<br />
**** The table can be sorted according to a certain parameter by clicking on the arrows next to the column name. Depending on how many requests there are, this may take a while. The order can be reversed by clicking the same arrows again.<br />
**** Note that aspect data requests are not selected by "AutoSel" because the website software currently can't determine whether they have been processed or executed. Their status is always "Pending". So the operator must know whether specific aspect data requests should be included.<br />
**** 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.<br />
*** 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.<br />
**** Requests with identical detector mask, pixel mask, data type, and scaling factor are grouped together. Ensure not including more than 3 different groups of data requests in an IOR<br />
**** Data requests can be manually added/removed by checking/unchecking the tick boxes.<br />
**** The telemetry can be found in SOOPKitchen by hovering your cursor of the STIX Analysis window.<br />
*** "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.<br />
<br />
==== Building the IOR ====<br />
* It is typical to build an IOR specially for the data requests. If possible, other telecommands required during the STP can be put in another IOR. This IOR should be executed on a different day to the data request IOR so as not to waste the daily 300 telecommand limit. However, data request and other telecommands can be put into the same IOR if needed.<br />
* Open [[STIX-Starlet]].<br />
* Prepare the IOR up until the point of adding sequences/telecommand as outlined in [[How to Create an IOR|How To Generate an IOR]].<br />
* Load in the data request JSON file by clicking yellow "open json" button at the right end of the toolbar.<br />
** 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.<br />
* 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.<br />
* Edit the wait times<br />
** The default wait time between each group is +8 hrs. This needs to be changed for the first group to 2 seconds.<br />
** 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.<br />
** Delays between L4 spectrogram requests aren't important. They will be queued. These can be left at 10 seconds.<br />
** If including an aspect data request, allow 30 minutes for each request in the wait time.<br />
* Once all data request wait times have been edited, convert them to absolute times clicking "Request" -> "Delta to Absolute"<br />
* Click Load JSON<br />
* Click Generate<br />
* Once ready, [[How to Create an IOR|Submit IOR for Internal Review]] in the usual way.<br />
* Once approved by the STIX team, [[How to Create an IOR|Submit IOR to SOC]] in the usual way.</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=How_to_Create_a_Data_Request_IOR&diff=16460How to Create a Data Request IOR2024-06-18T09:49:19Z<p>Hualin: </p>
<hr />
<div>== Important Background Information ==<br />
<br />
=== What is a Data Request IOR? ===<br />
A Data Request IOR includes sets of instructions for STIX to process its observations into certain data products (e.g. L1 or L4 Spectrogram) and send them back to Earth. These instructions correspond to data requests made by the community or the STIX team. (To learn more, see [[How to Create a Data Request|What is a Data Request?]]) Data Request IORs can only be issued during STIX Analysis Windows which are scheduled and defined on [[SOOP KITCHEN]].<br />
<br />
=== Data Request IOR Criteria ===<br />
A Data Request IOR must be compiled in line with the following criteria:<br />
* '''Highest priority data requests must be included first.''' Data Requests can have three priorities: High, Medium, and Low.<br />
* '''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.<br />
* '''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.<br />
* In an STP, different slots are scheduled for different purposes: spectrograms, large science data, etc. You can get the information from STIX operations team<br />
<br />
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.<br />
<br />
=== Data Request Status ===<br />
Data Requests have one of three statuses:<br />
* '''Executed''': The requested data has been received from STIX by the STIX Data Center and is available.<br />
* '''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.<br />
* '''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.<br />
* '''Failed''': The data request has been failed onboard, due to "bulk science data not found"<br />
<br />
=== Relationship to Other IORs ===<br />
While it is possible to mix data requests with other telecommands, it is standard prcatice to create an IOR just for data requests and another for other operations telecommands. An exception might be to include non-data request telecommands that MUST be run during the STIX analysis window. This makes it easier to ensure that STIX is operating nominally during the STIX analysis window and the telecommand limit of 300/day is being used more efficiently. Therefore, IORs should not overlap in time.<br />
<br />
== Generate a Data Request IOR ==<br />
<br />
=== Required Software ===<br />
See [[How to Create an IOR|Required Software]].<br />
<br />
=== How to Generate a Data Request IOR ===<br />
==== Retrieving the Data Requests ====<br />
* Confirm no other IORs are sending commands during the STIX analysis window.<br />
* Export the data requests from the STIX Data Center as a JSON file:<br />
*** 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.<br />
*** 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).<br />
*** Access a hidden toolbar by double-clicking the word "requests" in "STIX user data requests" above the "New" button.<br />
*** Check the tickboxes for the data requests to be included. Alternatively, click "AutoSel" to automatically select <300 data requests.<br />
**** Data requests should be selected in order of highest priority.<br />
**** Within each priority level, the requests involving older data should be picked first. Note requests for older data do not always correspond to lower IDs.<br />
**** The table can be sorted according to a certain parameter by clicking on the arrows next to the column name. Depending on how many requests there are, this may take a while. The order can be reversed by clicking the same arrows again.<br />
**** Note that aspect data requests are not selected by "AutoSel" because the website software currently can't determine whether they have been processed or executed. Their status is always "Pending". So the operator must know whether specific aspect data requests should be included.<br />
**** 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.<br />
*** 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.<br />
**** Data requests can be manually added/removed by checking/unchecking the tick boxes.<br />
**** The telemetry can be found in SOOPKitchen by hovering your cursor of the STIX Analysis window.<br />
*** "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.<br />
<br />
==== Building the IOR ====<br />
* It is typical to build an IOR specially for the data requests. If possible, other telecommands required during the STP can be put in another IOR. This IOR should be executed on a different day to the data request IOR so as not to waste the daily 300 telecommand limit. However, data request and other telecommands can be put into the same IOR if needed.<br />
* Open [[STIX-Starlet]].<br />
* Prepare the IOR up until the point of adding sequences/telecommand as outlined in [[How to Create an IOR|How To Generate an IOR]].<br />
* Load in the data request JSON file by clicking yellow "open json" button at the right end of the toolbar.<br />
** 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.<br />
* 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.<br />
* Edit the wait times<br />
** The default wait time between each group is +8 hrs. This needs to be changed for the first group to 2 seconds.<br />
** 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.<br />
** Delays between L4 spectrogram requests aren't important. They will be queued. These can be left at 10 seconds.<br />
** If including an aspect data request, allow 30 minutes for each request in the wait time.<br />
* Once all data request wait times have been edited, convert them to absolute times clicking "Request" -> "Delta to Absolute"<br />
* Click Load JSON<br />
* Click Generate<br />
* Once ready, [[How to Create an IOR|Submit IOR for Internal Review]] in the usual way.<br />
* Once approved by the STIX team, [[How to Create an IOR|Submit IOR to SOC]] in the usual way.</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=How_to_Create_a_Data_Request_IOR&diff=16459How to Create a Data Request IOR2024-06-18T09:47:03Z<p>Hualin: /* Data Request IOR Criteria */</p>
<hr />
<div>== Important Background Information ==<br />
<br />
=== What is a Data Request IOR? ===<br />
A Data Request IOR includes sets of instructions for STIX to process its observations into certain data products (e.g. L1 or L4 Spectrogram) and send them back to Earth. These instructions correspond to data requests made by the community or the STIX team. (To learn more, see [[How to Create a Data Request|What is a Data Request?]]) Data Request IORs can only be issued during STIX Analysis Windows which are scheduled and defined on [[SOOP KITCHEN]].<br />
<br />
=== Data Request IOR Criteria ===<br />
A Data Request IOR must be compiled in line with the following criteria:<br />
* '''Highest priority data requests must be included first.''' Data Requests can have three priorities: High, Medium, and Low.<br />
* '''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.<br />
* '''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.<br />
* In an STP, different slots are scheduled for different purposes: spectrograms, large science data, etc. You can get the information from STIX operations team<br />
<br />
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.<br />
<br />
=== Data Request Status ===<br />
Data Requests have one of three statuses:<br />
* '''Executed''': The requested data has been received from STIX by the STIX Data Center and is available.<br />
* '''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.<br />
* '''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.<br />
* '''Failed''': The data request has been failed onboard, due to "bulk science data not found"<br />
<br />
=== Relationship to Other IORs ===<br />
While it is possible to mix data requests with other telecommands, it is standard prcatice to create an IOR just for data requests and another for other operations telecommands. An exception might be to include non-data request telecommands that MUST be run during the STIX analysis window. This makes it easier to ensure that STIX is operating nominally during the STIX analysis window and the telecommand limit of 300/day is being used more efficiently. Therefore, IORs should not overlap in time.<br />
<br />
== Generate a Data Request IOR ==<br />
<br />
=== Required Software ===<br />
See [[How to Create an IOR|Required Software]].<br />
<br />
=== How to Generate a Data Request IOR ===<br />
==== Retrieving the Data Requests ====<br />
* Confirm no other IORs are sending commands during the STIX analysis window.<br />
* Export the data requests from the STIX Data Center as a JSON file. There are two API options, URL or website:<br />
** URL API<br />
*** Enter the following URL https://pub023.cs.technik.fhnw.ch/request/user-data-requests/ior/json/<start_id>/<end_id> where <start_id> and <end_id> are the start and end data request IDs to include, e.g. https://pub023.cs.technik.fhnw.ch/request/user-data-requests/ior/json/1030/1400. Only data requests in the range whose status is "Pending" will be included.<br />
*** Save the JSON file to your local computer.<br />
** Website API<br />
*** 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.<br />
*** 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).<br />
*** Access a hidden toolbar by double-clicking the word "requests" in "STIX user data requests" above the "New" button.<br />
*** Check the tickboxes for the data requests to be included. Alternatively, click "AutoSel" to automatically select <300 data requests.<br />
**** Data requests should be selected in order of highest priority.<br />
**** Within each priority level, the requests involving older data should be picked first. Note requests for older data do not always correspond to lower IDs.<br />
**** The table can be sorted according to a certain parameter by clicking on the arrows next to the column name. Depending on how many requests there are, this may take a while. The order can be reversed by clicking the same arrows again.<br />
**** Note that aspect data requests are not selected by "AutoSel" because the website software currently can't determine whether they have been processed or executed. Their status is always "Pending". So the operator must know whether specific aspect data requests should be included.<br />
**** 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.<br />
*** 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.<br />
**** Data requests can be manually added/removed by checking/unchecking the tick boxes.<br />
**** The telemetry can be found in SOOPKitchen by hovering your cursor of the STIX Analysis window.<br />
*** "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.<br />
<br />
==== Building the IOR ====<br />
* It is typical to build an IOR specially for the data requests. If possible, other telecommands required during the STP can be put in another IOR. This IOR should be executed on a different day to the data request IOR so as not to waste the daily 300 telecommand limit. However, data request and other telecommands can be put into the same IOR if needed.<br />
* Open [[STIX-Starlet]].<br />
* Prepare the IOR up until the point of adding sequences/telecommand as outlined in [[How to Create an IOR|How To Generate an IOR]].<br />
* Load in the data request JSON file by clicking yellow "open json" button at the right end of the toolbar.<br />
** 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.<br />
* 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.<br />
* Edit the wait times<br />
** The default wait time between each group is +8 hrs. This needs to be changed for the first group to 2 seconds.<br />
** 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.<br />
** Delays between L4 spectrogram requests aren't important. They will be queued. These can be left at 10 seconds.<br />
** If including an aspect data request, allow 30 minutes for each request in the wait time.<br />
* Once all data request wait times have been edited, convert them to absolute times clicking "Request" -> "Delta to Absolute"<br />
* Click Load JSON<br />
* Click Generate<br />
* Once ready, [[How to Create an IOR|Submit IOR for Internal Review]] in the usual way.<br />
* Once approved by the STIX team, [[How to Create an IOR|Submit IOR to SOC]] in the usual way.</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=How_to_Create_a_Data_Request_IOR&diff=16458How to Create a Data Request IOR2024-06-18T09:45:08Z<p>Hualin: /* Important Background Information */</p>
<hr />
<div>== Important Background Information ==<br />
<br />
=== What is a Data Request IOR? ===<br />
A Data Request IOR includes sets of instructions for STIX to process its observations into certain data products (e.g. L1 or L4 Spectrogram) and send them back to Earth. These instructions correspond to data requests made by the community or the STIX team. (To learn more, see [[How to Create a Data Request|What is a Data Request?]]) Data Request IORs can only be issued during STIX Analysis Windows which are scheduled and defined on [[SOOP KITCHEN]].<br />
<br />
=== Data Request IOR Criteria ===<br />
A Data Request IOR must be compiled in line with the following criteria:<br />
* '''Highest priority data requests must be included first.''' Data Requests can have three priorities: High, Medium, and Low.<br />
* '''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.<br />
* '''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.<br />
<br />
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.<br />
<br />
=== Data Request Status ===<br />
Data Requests have one of three statuses:<br />
* '''Executed''': The requested data has been received from STIX by the STIX Data Center and is available.<br />
* '''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.<br />
* '''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.<br />
* '''Failed''': The data request has been failed onboard, due to "bulk science data not found"<br />
<br />
=== Relationship to Other IORs ===<br />
While it is possible to mix data requests with other telecommands, it is standard prcatice to create an IOR just for data requests and another for other operations telecommands. An exception might be to include non-data request telecommands that MUST be run during the STIX analysis window. This makes it easier to ensure that STIX is operating nominally during the STIX analysis window and the telecommand limit of 300/day is being used more efficiently. Therefore, IORs should not overlap in time.<br />
<br />
== Generate a Data Request IOR ==<br />
<br />
=== Required Software ===<br />
See [[How to Create an IOR|Required Software]].<br />
<br />
=== How to Generate a Data Request IOR ===<br />
==== Retrieving the Data Requests ====<br />
* Confirm no other IORs are sending commands during the STIX analysis window.<br />
* Export the data requests from the STIX Data Center as a JSON file. There are two API options, URL or website:<br />
** URL API<br />
*** Enter the following URL https://pub023.cs.technik.fhnw.ch/request/user-data-requests/ior/json/<start_id>/<end_id> where <start_id> and <end_id> are the start and end data request IDs to include, e.g. https://pub023.cs.technik.fhnw.ch/request/user-data-requests/ior/json/1030/1400. Only data requests in the range whose status is "Pending" will be included.<br />
*** Save the JSON file to your local computer.<br />
** Website API<br />
*** 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.<br />
*** 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).<br />
*** Access a hidden toolbar by double-clicking the word "requests" in "STIX user data requests" above the "New" button.<br />
*** Check the tickboxes for the data requests to be included. Alternatively, click "AutoSel" to automatically select <300 data requests.<br />
**** Data requests should be selected in order of highest priority.<br />
**** Within each priority level, the requests involving older data should be picked first. Note requests for older data do not always correspond to lower IDs.<br />
**** The table can be sorted according to a certain parameter by clicking on the arrows next to the column name. Depending on how many requests there are, this may take a while. The order can be reversed by clicking the same arrows again.<br />
**** Note that aspect data requests are not selected by "AutoSel" because the website software currently can't determine whether they have been processed or executed. Their status is always "Pending". So the operator must know whether specific aspect data requests should be included.<br />
**** 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.<br />
*** 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.<br />
**** Data requests can be manually added/removed by checking/unchecking the tick boxes.<br />
**** The telemetry can be found in SOOPKitchen by hovering your cursor of the STIX Analysis window.<br />
*** "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.<br />
<br />
==== Building the IOR ====<br />
* It is typical to build an IOR specially for the data requests. If possible, other telecommands required during the STP can be put in another IOR. This IOR should be executed on a different day to the data request IOR so as not to waste the daily 300 telecommand limit. However, data request and other telecommands can be put into the same IOR if needed.<br />
* Open [[STIX-Starlet]].<br />
* Prepare the IOR up until the point of adding sequences/telecommand as outlined in [[How to Create an IOR|How To Generate an IOR]].<br />
* Load in the data request JSON file by clicking yellow "open json" button at the right end of the toolbar.<br />
** 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.<br />
* 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.<br />
* Edit the wait times<br />
** The default wait time between each group is +8 hrs. This needs to be changed for the first group to 2 seconds.<br />
** 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.<br />
** Delays between L4 spectrogram requests aren't important. They will be queued. These can be left at 10 seconds.<br />
** If including an aspect data request, allow 30 minutes for each request in the wait time.<br />
* Once all data request wait times have been edited, convert them to absolute times clicking "Request" -> "Delta to Absolute"<br />
* Click Load JSON<br />
* Click Generate<br />
* Once ready, [[How to Create an IOR|Submit IOR for Internal Review]] in the usual way.<br />
* Once approved by the STIX team, [[How to Create an IOR|Submit IOR to SOC]] in the usual way.</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=How_to_Create_an_IOR&diff=16457How to Create an IOR2024-06-18T09:42:53Z<p>Hualin: /* Submit IOR to SOC */</p>
<hr />
<div>An IOR (Instrument Operations Response) is a series of instructions (telecommands) telling STIX what to do. An IOR is uploaded to STIX each STP cycle which is typically a week long. The process for uploading an IOR is as follows:<br />
# [[#Generate an IOR|Generate an IOR]];<br />
# [[#Test IOR on Ground Unit|Test IOR on Ground Unit]];<br />
# [[#Submit IOR for Internal Review|Submit IOR for Internal Review]]<br />
# [[#Submit IOR to SOC|Submit IOR to SOC]]<br />
Below focuses on article will focus on the first step, creating an IOR. For definitions of acronyms used in this page, see [[Acronyms & Definitions]].<br />
<br />
== Generate an IOR ==<br />
=== Required Software ===<br />
We suggest using STIX virtual server to generate IORs. <br />
The tutorial for logging onto the server can be found at<br />
<br />
https://v000658.fhnw.ch/index.php/s/7ADcnSNExFNPCyF<br />
<br />
If you create IORs with your local machine, you need to install starlet.<br />
<br />
* [[STIX-Starlet]]<br />
For instructions installing these packages, click on the package link above.<br />
<br />
=== How To Generate an IOR ===<br />
* Check the STP schedule on the [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/Cruise+Phase Solar Orbiter wiki]. GIVE BETTER INSTRUCTIONS ON HOW TO FIND THE RELEVANT INFO FROM THIS LINK. Take note of:<br />
** The STP number/cycle;<br />
** The deadline for IOR submission deadline to the Solar Orbiter SOC; GIVE INSTRUCTIONS ON HOW TO FIND THIS INFO IN THE TABLE VIA THE ABOVE LINK.<br />
** The onboard IOR start time (equivalent to the STP start time).<br />
* Log into [[SOOP KITCHEN]] and check whether there is an "analysis window" in the current STP. If there is an analysis window, we must include data requests as part of the IOR.<br />
** The start time, duration and end time of the STP/IOR can also be confirmed via [[SOOP KITCHEN]].<br />
* Download necessary input files. See nested bullets below. All can be found at https://pub023.cs.technik.fhnw.ch/gfts/solsoc/from_soc/ (This page is password protected. Contact Hualin at hualin.xiao@fhnw.ch to get access):<br />
** MIB:<br />
*** Check the current version number on [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/MIB+and+FOP Solar Orbiter wiki]. It is given by the "MIB Name" column.<br />
*** Ctrl+F the version number on the above pub023 web address and download.<br />
*** Unzip the file.<br />
<br />
** LTP timeline JSON file<br />
*** The JSON file contains certain info on the STP, e.g. the start and end time.<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The json file for the correct LTP must be used otherwise Startlet will not process the IOR correctly.<br />
*** There is one json per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Download latest version from the above pub023 URL. (The version here is usually the latest.)<br />
* Open [[STIX-Starlet]] and enter IOR metadata.<br />
** Set directory where IOR will be generated. Settings -> Set storage directory<br />
** Set Starlet to STIX format. Settings -> Instrument -> STIX<br />
** Enter the STP number from STP schedule into STP cycle field<br />
** Add your name in author field.<br />
** Add onboard start time from the STP schedule in the start time field.<br />
** End time must be before the next STP and next IOR starts (whichever is earliest), and after all telecommands have been executed. A typical value would be 24 hours after the IOR start time.<br />
** If this is the first IOR for the current STP, set the file and version numbers to 1.<br />
*** If an IOR has to be recreated due to an issue found in review, iterate version number.<br />
*** If more the STP requires more than one distinct IOR, iterate the file number<br />
* Enter the paths of the required files:<br />
** MiB: Settings -> Set instrument Database. Then select the unzipped MIB directory.<br />
** Timeline JSON: Do the same as for E-FECS and TMC. DO NOT click "Load JSON" at this stage.<br />
* Add telecommands via the "Add Sequence".<br />
** STIX commands are prefixed at "AIX". Enter this is in the search field at the top to filter out non-STIX sequences.<br />
** See [[IOR Tips and Tricks]] for more advice.<br />
** In particular, see [[IOR Tips and Tricks#Time of First Telecommand|Time of First Telecommand]] for when to start the first telecommand of the IOR.<br />
** To include data requests in the IOR, see the section below on [[#Including a Data Request in an IOR|Including a Data Request in an IOR]]<br />
* Once all sequences are added, click "Load JSON" button. This will assign OBS ID to all telecommands. <br />
* Generate IOR by clicking "Generate" button. This will create a .SOL file in the "storage directory" set above.<br />
<br />
== Test IOR on Ground Unit (Optional) ==<br />
<br />
* If you still have the IOR open in STIX-Starlet, save the IOR to as a <code>.tcl</code> by clicking the <code>.tcl</code> button in the toolbar.<br />
<br />
See [[Using the STIX Ground Unit#Testing an IOR with the Ground Unit|Testing an IOR with the Ground Unit]].<br />
<br />
== Submit IOR for Internal Review ==<br />
* Upload IOR .SOL file by clicking the "Upload IOR" button at https://pub023.cs.technik.fhnw.ch/view/operations<br />
* Email the link to the IOR overview to the STIX ops team.<br />
** The IOR overview URL can be found by locating the IOR at the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] and clicking the green button in the "Overview" column.<br />
<br />
== Submit IOR to SOC ==<br />
Once the STIX team is happy with the IOR, submit it to the SOC by doing the following before the <b>IOR delivery deadline</b>:<br />
* Generate and download an IORG zip file corresponding to the IOR to be submitted.<br />
** Find the ID of the IOR from the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] on the STIX server.<br />
** Go to https://pub023.cs.technik.fhnw.ch/view/operations and click the button marked "Create IORG File".<br />
** Enter the ID of the first IOR into the start field and the ID of the last IOR to be included in the end field. Also enter the STP number and the IOR number (in most cases this is 1). Then click "Create and Download".<br />
* Send the IORG file to the SOC<br />
** You will need a server account write permissions. To get an account email Hualin at hualin.xiao@fhnw.ch or Dan Ryan at daniel.ryan@fhnw.ch<br />
** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Copy the IORG zip file to [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by opening a terminal and <code>cd</code> to the directory where you saved the IORG file above. Then type <code>sudo scp <IORG filename> <username>@147.86.8.26:~</code> where <code><IORG filename></code> is the name of the IORG file and <code><username></code> is the username of your account on the STIX GFTS server.<br />
** Login into the [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by typing <code>ssh <username>@147.86.8.26</code><br />
*** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Change permissions on the IORG file: <code>sudo chmod 777 <IORG filename></code><br />
** Move the IORG file from the home directory (where we copied it to above) to the <code>to_soc</code> directory by typing <code>sudo cp ~/<IORG filename> /home/solsoc/to_soc/</code><br />
* Confirm the SOC has validated the IOR<br />
** The SOC will copy the file from the <code>to_soc</code> and then delete it. This can happen straight away. The SOC will then run an automatically verify the IOR and then return a <code>.CRR</code> back to the <code>/home/solsoc/from_soc</code> directory within 10 minutes.<br />
** <code>cd</code> to the <code>home/solsoc/from_soc</code> and wait for the <code>.CRR</code> to appear. It will have the same filename as the submitted IORG file, but with a <code>.CRR</code> extension.<br />
** Once the file has arrived, log out of the server.<br />
** Copy the <code>.CRR</code> file to your local machine by typing: <code>scp <username>@147.86.8.26:/home/solsoc/from_soc/<IORG filename> /local/folder/</code> where <code>/local/folder/</code> is the location on your local machine where the file should be copied.<br />
** Unzip the <code>.CRR</code> and open it with a text editor.<br />
** Search for the <validity> tag and confirm the message says "Valid".<br />
*** If the .CRR file reports "Valid", then we are done!<br />
*** If it is not valid, more details of the errors will be listed. Create a new version of the IOR (remembering to iterate the version number) that fixes those errors and resubmit.<br />
<br />
== Including a Data Request in an IOR ==<br />
See [[How to Create a Data Request IOR]]</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=How_to_Create_an_IOR&diff=16456How to Create an IOR2024-06-18T09:39:16Z<p>Hualin: </p>
<hr />
<div>An IOR (Instrument Operations Response) is a series of instructions (telecommands) telling STIX what to do. An IOR is uploaded to STIX each STP cycle which is typically a week long. The process for uploading an IOR is as follows:<br />
# [[#Generate an IOR|Generate an IOR]];<br />
# [[#Test IOR on Ground Unit|Test IOR on Ground Unit]];<br />
# [[#Submit IOR for Internal Review|Submit IOR for Internal Review]]<br />
# [[#Submit IOR to SOC|Submit IOR to SOC]]<br />
Below focuses on article will focus on the first step, creating an IOR. For definitions of acronyms used in this page, see [[Acronyms & Definitions]].<br />
<br />
== Generate an IOR ==<br />
=== Required Software ===<br />
We suggest using STIX virtual server to generate IORs. <br />
The tutorial for logging onto the server can be found at<br />
<br />
https://v000658.fhnw.ch/index.php/s/7ADcnSNExFNPCyF<br />
<br />
If you create IORs with your local machine, you need to install starlet.<br />
<br />
* [[STIX-Starlet]]<br />
For instructions installing these packages, click on the package link above.<br />
<br />
=== How To Generate an IOR ===<br />
* Check the STP schedule on the [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/Cruise+Phase Solar Orbiter wiki]. GIVE BETTER INSTRUCTIONS ON HOW TO FIND THE RELEVANT INFO FROM THIS LINK. Take note of:<br />
** The STP number/cycle;<br />
** The deadline for IOR submission deadline to the Solar Orbiter SOC; GIVE INSTRUCTIONS ON HOW TO FIND THIS INFO IN THE TABLE VIA THE ABOVE LINK.<br />
** The onboard IOR start time (equivalent to the STP start time).<br />
* Log into [[SOOP KITCHEN]] and check whether there is an "analysis window" in the current STP. If there is an analysis window, we must include data requests as part of the IOR.<br />
** The start time, duration and end time of the STP/IOR can also be confirmed via [[SOOP KITCHEN]].<br />
* Download necessary input files. See nested bullets below. All can be found at https://pub023.cs.technik.fhnw.ch/gfts/solsoc/from_soc/ (This page is password protected. Contact Hualin at hualin.xiao@fhnw.ch to get access):<br />
** MIB:<br />
*** Check the current version number on [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/MIB+and+FOP Solar Orbiter wiki]. It is given by the "MIB Name" column.<br />
*** Ctrl+F the version number on the above pub023 web address and download.<br />
*** Unzip the file.<br />
<br />
** LTP timeline JSON file<br />
*** The JSON file contains certain info on the STP, e.g. the start and end time.<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The json file for the correct LTP must be used otherwise Startlet will not process the IOR correctly.<br />
*** There is one json per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Download latest version from the above pub023 URL. (The version here is usually the latest.)<br />
* Open [[STIX-Starlet]] and enter IOR metadata.<br />
** Set directory where IOR will be generated. Settings -> Set storage directory<br />
** Set Starlet to STIX format. Settings -> Instrument -> STIX<br />
** Enter the STP number from STP schedule into STP cycle field<br />
** Add your name in author field.<br />
** Add onboard start time from the STP schedule in the start time field.<br />
** End time must be before the next STP and next IOR starts (whichever is earliest), and after all telecommands have been executed. A typical value would be 24 hours after the IOR start time.<br />
** If this is the first IOR for the current STP, set the file and version numbers to 1.<br />
*** If an IOR has to be recreated due to an issue found in review, iterate version number.<br />
*** If more the STP requires more than one distinct IOR, iterate the file number<br />
* Enter the paths of the required files:<br />
** MiB: Settings -> Set instrument Database. Then select the unzipped MIB directory.<br />
** Timeline JSON: Do the same as for E-FECS and TMC. DO NOT click "Load JSON" at this stage.<br />
* Add telecommands via the "Add Sequence".<br />
** STIX commands are prefixed at "AIX". Enter this is in the search field at the top to filter out non-STIX sequences.<br />
** See [[IOR Tips and Tricks]] for more advice.<br />
** In particular, see [[IOR Tips and Tricks#Time of First Telecommand|Time of First Telecommand]] for when to start the first telecommand of the IOR.<br />
** To include data requests in the IOR, see the section below on [[#Including a Data Request in an IOR|Including a Data Request in an IOR]]<br />
* Once all sequences are added, click "Load JSON" button. This will assign OBS ID to all telecommands. <br />
* Generate IOR by clicking "Generate" button. This will create a .SOL file in the "storage directory" set above.<br />
<br />
== Test IOR on Ground Unit (Optional) ==<br />
<br />
* If you still have the IOR open in STIX-Starlet, save the IOR to as a <code>.tcl</code> by clicking the <code>.tcl</code> button in the toolbar.<br />
<br />
See [[Using the STIX Ground Unit#Testing an IOR with the Ground Unit|Testing an IOR with the Ground Unit]].<br />
<br />
== Submit IOR for Internal Review ==<br />
* Upload IOR .SOL file by clicking the "Upload IOR" button at https://pub023.cs.technik.fhnw.ch/view/operations<br />
* Email the link to the IOR overview to the STIX ops team.<br />
** The IOR overview URL can be found by locating the IOR at the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] and clicking the green button in the "Overview" column.<br />
<br />
== Submit IOR to SOC ==<br />
Once the STIX team is happy with the IOR, submit it to the SOC by doing the following:<br />
* Generate and download an IORG zip file corresponding to the IOR to be submitted.<br />
** Find the ID of the IOR from the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] on the STIX server.<br />
** Go to https://pub023.cs.technik.fhnw.ch/view/operations and click the button marked "Create IORG File".<br />
** Enter the ID of the first IOR into the start field and the ID of the last IOR to be included in the end field. Also enter the STP number and the IOR number (in most cases this is 1). Then click "Create and Download".<br />
* Send the IORG file to the SOC<br />
** You will need a server account write permissions. To get an account email Hualin at hualin.xiao@fhnw.ch or Dan Ryan at daniel.ryan@fhnw.ch<br />
** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Copy the IORG zip file to [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by opening a terminal and <code>cd</code> to the directory where you saved the IORG file above. Then type <code>sudo scp <IORG filename> <username>@147.86.8.26:~</code> where <code><IORG filename></code> is the name of the IORG file and <code><username></code> is the username of your account on the STIX GFTS server.<br />
** Login into the [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by typing <code>ssh <username>@147.86.8.26</code><br />
*** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Change permissions on the IORG file: <code>sudo chmod 777 <IORG filename></code><br />
** Move the IORG file from the home directory (where we copied it to above) to the <code>to_soc</code> directory by typing <code>sudo cp ~/<IORG filename> /home/solsoc/to_soc/</code><br />
* Confirm the SOC has validated the IOR<br />
** The SOC will copy the file from the <code>to_soc</code> and then delete it. This can happen straight away. The SOC will then run an automatically verify the IOR and then return a <code>.CRR</code> back to the <code>/home/solsoc/from_soc</code> directory within 10 minutes.<br />
** <code>cd</code> to the <code>home/solsoc/from_soc</code> and wait for the <code>.CRR</code> to appear. It will have the same filename as the submitted IORG file, but with a <code>.CRR</code> extension.<br />
** Once the file has arrived, log out of the server.<br />
** Copy the <code>.CRR</code> file to your local machine by typing: <code>scp <username>@147.86.8.26:/home/solsoc/from_soc/<IORG filename> /local/folder/</code> where <code>/local/folder/</code> is the location on your local machine where the file should be copied.<br />
** Unzip the <code>.CRR</code> and open it with a text editor.<br />
** Search for the <validity> tag and confirm the message says "Valid".<br />
*** If the .CRR file reports "Valid", then we are done!<br />
*** If it is not valid, more details of the errors will be listed. Create a new version of the IOR (remembering to iterate the version number) that fixes those errors and resubmit.<br />
<br />
== Including a Data Request in an IOR ==<br />
See [[How to Create a Data Request IOR]]</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=How_to_Create_an_IOR&diff=16455How to Create an IOR2024-06-18T09:37:16Z<p>Hualin: </p>
<hr />
<div>An IOR (Instrument Operations Response) is a series of instructions (telecommands) telling STIX what to do. An IOR is uploaded to STIX each STP cycle which is typically a week long. The process for uploading an IOR is as follows:<br />
# [[#Generate an IOR|Generate an IOR]];<br />
# [[#Test IOR on Ground Unit|Test IOR on Ground Unit]];<br />
# [[#Submit IOR for Internal Review|Submit IOR for Internal Review]]<br />
# [[#Submit IOR to SOC|Submit IOR to SOC]]<br />
Below focuses on article will focus on the first step, creating an IOR. For definitions of acronyms used in this page, see [[Acronyms & Definitions]].<br />
<br />
== Generate an IOR ==<br />
=== Required Software ===<br />
We suggest using STIX virtual server to generate IORs. <br />
The tutorial for logging onto the server can be found at<br />
<br />
https://v000658.fhnw.ch/index.php/s/7ADcnSNExFNPCyF<br />
<br />
If you create IORs with your local machine, you need to install starlet.<br />
<br />
* [[STIX-Starlet]]<br />
For instructions installing these packages, click on the package link above.<br />
<br />
=== How To Generate an IOR ===<br />
* Check the STP schedule on the [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/Cruise+Phase Solar Orbiter wiki]. GIVE BETTER INSTRUCTIONS ON HOW TO FIND THE RELEVANT INFO FROM THIS LINK. Take note of:<br />
** The STP number/cycle;<br />
** The deadline for IOR submission deadline to the Solar Orbiter SOC; GIVE INSTRUCTIONS ON HOW TO FIND THIS INFO IN THE TABLE VIA THE ABOVE LINK.<br />
** The onboard IOR start time (equivalent to the STP start time).<br />
* Log into [[SOOP KITCHEN]] and check whether there is an "analysis window" in the current STP. If there is an analysis window, we must include data requests as part of the IOR.<br />
** The start time, duration and end time of the STP/IOR can also be confirmed via [[SOOP KITCHEN]].<br />
* Download necessary input files. See nested bullets below. All can be found at https://pub023.cs.technik.fhnw.ch/gfts/solsoc/from_soc/ (This page is password protected. Contact Hualin at hualin.xiao@fhnw.ch to get access):<br />
** MIB:<br />
*** Check the current version number on [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/MIB+and+FOP Solar Orbiter wiki]. It is given by the "MIB Name" column.<br />
*** Ctrl+F the version number on the above pub023 web address and download.<br />
*** Unzip the file.<br />
<br />
** LTP timeline JSON file<br />
*** The JSON file contains certain info on the STP, e.g. the start and end time.<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The json file for the correct LTP must be used otherwise Startlet will not process the IOR correctly.<br />
*** There is one json per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Download latest version from the above pub023 URL. (The version here is usually the latest.)<br />
* Open [[STIX-Starlet]] and enter IOR metadata.<br />
** Set directory where IOR will be generated. Settings -> Set storage directory<br />
** Set Starlet to STIX format. Settings -> Instrument -> STIX<br />
** Enter the STP number from STP schedule into STP cycle field<br />
** Add your name in author field.<br />
** Add onboard start time from the STP schedule in the start time field.<br />
** End time must be before the next STP and next IOR starts (whichever is earliest), and after all telecommands have been executed. A typical value would be 24 hours after the IOR start time.<br />
** If this is the first IOR for the current STP, set the file and version numbers to 1.<br />
*** If an IOR has to be recreated due to an issue found in review, iterate version number.<br />
*** If more the STP requires more than one distinct IOR, iterate the file number<br />
* Enter the paths of the required files:<br />
** MiB: Settings -> Set instrument Database. Then select the unzipped MIB directory.<br />
** Timeline JSON: Do the same as for E-FECS and TMC. DO NOT click "Load JSON" at this stage.<br />
* Add telecommands via the "Add Sequence".<br />
** STIX commands are prefixed at "AIX". Enter this is in the search field at the top to filter out non-STIX sequences.<br />
** See [[IOR Tips and Tricks]] for more advice.<br />
** In particular, see [[IOR Tips and Tricks#Time of First Telecommand|Time of First Telecommand]] for when to start the first telecommand of the IOR.<br />
** To include data requests in the IOR, see the section below on [[#Including a Data Request in an IOR|Including a Data Request in an IOR]]<br />
* Once all sequences are added, click "Load JSON" button. This will assign OBS ID to all telecommands. These should all be the same for a given STP.<br />
* Generate IOR by clicking "Generate" button. This will create a .SOL file in the "storage directory" set above.<br />
<br />
== Test IOR on Ground Unit ==<br />
* If you still have the IOR open in STIX-Starlet, save the IOR to as a <code>.tcl</code> by clicking the <code>.tcl</code> button in the toolbar.<br />
<br />
See [[Using the STIX Ground Unit#Testing an IOR with the Ground Unit|Testing an IOR with the Ground Unit]].<br />
<br />
== Submit IOR for Internal Review ==<br />
* Upload IOR .SOL file by clicking the "Upload IOR" button at https://pub023.cs.technik.fhnw.ch/view/operations<br />
* Email the link to the IOR overview to the STIX ops team.<br />
** The IOR overview URL can be found by locating the IOR at the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] and clicking the green button in the "Overview" column.<br />
<br />
== Submit IOR to SOC ==<br />
Once the STIX team is happy with the IOR, submit it to the SOC by doing the following:<br />
* Generate and download an IORG zip file corresponding to the IOR to be submitted.<br />
** Find the ID of the IOR from the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] on the STIX server.<br />
** Go to https://pub023.cs.technik.fhnw.ch/view/operations and click the button marked "Create IORG File".<br />
** Enter the ID of the first IOR into the start field and the ID of the last IOR to be included in the end field. Also enter the STP number and the IOR number (in most cases this is 1). Then click "Create and Download".<br />
* Send the IORG file to the SOC<br />
** You will need a server account write permissions. To get an account email Hualin at hualin.xiao@fhnw.ch or Dan Ryan at daniel.ryan@fhnw.ch<br />
** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Copy the IORG zip file to [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by opening a terminal and <code>cd</code> to the directory where you saved the IORG file above. Then type <code>sudo scp <IORG filename> <username>@147.86.8.26:~</code> where <code><IORG filename></code> is the name of the IORG file and <code><username></code> is the username of your account on the STIX GFTS server.<br />
** Login into the [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by typing <code>ssh <username>@147.86.8.26</code><br />
*** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Change permissions on the IORG file: <code>sudo chmod 777 <IORG filename></code><br />
** Move the IORG file from the home directory (where we copied it to above) to the <code>to_soc</code> directory by typing <code>sudo cp ~/<IORG filename> /home/solsoc/to_soc/</code><br />
* Confirm the SOC has validated the IOR<br />
** The SOC will copy the file from the <code>to_soc</code> and then delete it. This can happen straight away. The SOC will then run an automatically verify the IOR and then return a <code>.CRR</code> back to the <code>/home/solsoc/from_soc</code> directory within 10 minutes.<br />
** <code>cd</code> to the <code>home/solsoc/from_soc</code> and wait for the <code>.CRR</code> to appear. It will have the same filename as the submitted IORG file, but with a <code>.CRR</code> extension.<br />
** Once the file has arrived, log out of the server.<br />
** Copy the <code>.CRR</code> file to your local machine by typing: <code>scp <username>@147.86.8.26:/home/solsoc/from_soc/<IORG filename> /local/folder/</code> where <code>/local/folder/</code> is the location on your local machine where the file should be copied.<br />
** Unzip the <code>.CRR</code> and open it with a text editor.<br />
** Search for the <validity> tag and confirm the message says "Valid".<br />
*** If the .CRR file reports "Valid", then we are done!<br />
*** If it is not valid, more details of the errors will be listed. Create a new version of the IOR (remembering to iterate the version number) that fixes those errors and resubmit.<br />
<br />
== Including a Data Request in an IOR ==<br />
See [[How to Create a Data Request IOR]]</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=How_to_Create_an_IOR&diff=16454How to Create an IOR2024-06-18T09:35:04Z<p>Hualin: </p>
<hr />
<div>An IOR (Instrument Operations Response) is a series of instructions (telecommands) telling STIX what to do. An IOR is uploaded to STIX each STP cycle which is typically a week long. The process for uploading an IOR is as follows:<br />
# [[#Generate an IOR|Generate an IOR]];<br />
# [[#Test IOR on Ground Unit|Test IOR on Ground Unit]];<br />
# [[#Submit IOR for Internal Review|Submit IOR for Internal Review]]<br />
# [[#Submit IOR to SOC|Submit IOR to SOC]]<br />
Below focuses on article will focus on the first step, creating an IOR. For definitions of acronyms used in this page, see [[Acronyms & Definitions]].<br />
<br />
== Generate an IOR ==<br />
=== Required Software ===<br />
We suggest using STIX virtual server to generate IORs. <br />
The tutorial for logging onto the server can be found at<br />
<br />
https://v000658.fhnw.ch/index.php/s/7ADcnSNExFNPCyF<br />
<br />
If you create IORs with your local machine, you need to install starlet.<br />
<br />
* [[STIX-Starlet]]<br />
For instructions installing these packages, click on the package link above.<br />
<br />
=== How To Generate an IOR ===<br />
* Check the STP schedule on the [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/Cruise+Phase Solar Orbiter wiki]. GIVE BETTER INSTRUCTIONS ON HOW TO FIND THE RELEVANT INFO FROM THIS LINK. Take note of:<br />
** The STP number/cycle;<br />
** The deadline for IOR submission deadline to the Solar Orbiter SOC; GIVE INSTRUCTIONS ON HOW TO FIND THIS INFO IN THE TABLE VIA THE ABOVE LINK.<br />
** The onboard IOR start time (equivalent to the STP start time).<br />
* Log into [[SOOP KITCHEN]] and check whether there is an "analysis window" in the current STP. If there is an analysis window, we must include data requests as part of the IOR.<br />
** The start time, duration and end time of the STP/IOR can also be confirmed via [[SOOP KITCHEN]].<br />
* Download necessary input files. See nested bullets below. All can be found at https://pub023.cs.technik.fhnw.ch/gfts/solsoc/from_soc/ (This page is password protected. Contact Hualin at hualin.xiao@fhnw.ch to get access):<br />
** MIB:<br />
*** Check the current version number on [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/MIB+and+FOP Solar Orbiter wiki]. It is given by the "MIB Name" column.<br />
*** Ctrl+F the version number on the above pub023 web address and download.<br />
*** Unzip the file.<br />
<br />
** LTP timeline JSON file<br />
*** The JSON file contains certain info on the STP, e.g. the start and end time.<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The json file for the correct LTP must be used otherwise Startlet will not process the IOR correctly.<br />
*** There is one json per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Download latest version from the above pub023 URL. (The version here is usually the latest.)<br />
* Open [[STIX-Starlet]] and enter IOR metadata.<br />
** Set directory where IOR will be generated. Settings -> Set storage directory<br />
** Set Starlet to STIX format. Settings -> Instrument -> STIX<br />
** Enter the STP number from STP schedule into STP cycle field<br />
** Add your name in author field.<br />
** Add onboard start time from the STP schedule in the start time field.<br />
** End time must be before the next STP and next IOR starts (whichever is earliest), and after all telecommands have been executed. A typical value would be 24 hours after the IOR start time.<br />
** If this is the first IOR for the current STP, set the file and version numbers to 1.<br />
*** If an IOR has to be recreated due to an issue found in review, iterate version number.<br />
*** If more the STP requires more than one distinct IOR, iterate the file number<br />
* Enter the paths of the required files:<br />
** MiB: Settings -> Set instrument Database. Then select the unzipped MIB directory.<br />
** E-FECS & TMC: Click folder icon on the right of the value fields and select the relevant files.<br />
** JSON: Do the same as for E-FECS and TMC. DO NOT click "Load JSON" at this stage.<br />
* Add telecommands via the "Add Sequence".<br />
** STIX commands are prefixed at "AIX". Enter this is in the search field at the top to filter out non-STIX sequences.<br />
** See [[IOR Tips and Tricks]] for more advice.<br />
** In particular, see [[IOR Tips and Tricks#Time of First Telecommand|Time of First Telecommand]] for when to start the first telecommand of the IOR.<br />
** To include data requests in the IOR, see the section below on [[#Including a Data Request in an IOR|Including a Data Request in an IOR]]<br />
* Once all sequences are added, click "Load JSON" button. This will assign OBS ID to all telecommands. These should all be the same for a given STP.<br />
* Generate IOR by clicking "Generate" button. This will create a .SOL file in the "storage directory" set above.<br />
<br />
== Test IOR on Ground Unit ==<br />
* If you still have the IOR open in STIX-Starlet, save the IOR to as a <code>.tcl</code> by clicking the <code>.tcl</code> button in the toolbar.<br />
<br />
See [[Using the STIX Ground Unit#Testing an IOR with the Ground Unit|Testing an IOR with the Ground Unit]].<br />
<br />
== Submit IOR for Internal Review ==<br />
* Upload IOR .SOL file by clicking the "Upload IOR" button at https://pub023.cs.technik.fhnw.ch/view/operations<br />
* Email the link to the IOR overview to the STIX ops team.<br />
** The IOR overview URL can be found by locating the IOR at the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] and clicking the green button in the "Overview" column.<br />
<br />
== Submit IOR to SOC ==<br />
Once the STIX team is happy with the IOR, submit it to the SOC by doing the following:<br />
* Generate and download an IORG zip file corresponding to the IOR to be submitted.<br />
** Find the ID of the IOR from the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] on the STIX server.<br />
** Go to https://pub023.cs.technik.fhnw.ch/view/operations and click the button marked "Create IORG File".<br />
** Enter the ID of the first IOR into the start field and the ID of the last IOR to be included in the end field. Also enter the STP number and the IOR number (in most cases this is 1). Then click "Create and Download".<br />
* Send the IORG file to the SOC<br />
** You will need a server account write permissions. To get an account email Hualin at hualin.xiao@fhnw.ch or Dan Ryan at daniel.ryan@fhnw.ch<br />
** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Copy the IORG zip file to [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by opening a terminal and <code>cd</code> to the directory where you saved the IORG file above. Then type <code>sudo scp <IORG filename> <username>@147.86.8.26:~</code> where <code><IORG filename></code> is the name of the IORG file and <code><username></code> is the username of your account on the STIX GFTS server.<br />
** Login into the [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by typing <code>ssh <username>@147.86.8.26</code><br />
*** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Change permissions on the IORG file: <code>sudo chmod 777 <IORG filename></code><br />
** Move the IORG file from the home directory (where we copied it to above) to the <code>to_soc</code> directory by typing <code>sudo cp ~/<IORG filename> /home/solsoc/to_soc/</code><br />
* Confirm the SOC has validated the IOR<br />
** The SOC will copy the file from the <code>to_soc</code> and then delete it. This can happen straight away. The SOC will then run an automatically verify the IOR and then return a <code>.CRR</code> back to the <code>/home/solsoc/from_soc</code> directory within 10 minutes.<br />
** <code>cd</code> to the <code>home/solsoc/from_soc</code> and wait for the <code>.CRR</code> to appear. It will have the same filename as the submitted IORG file, but with a <code>.CRR</code> extension.<br />
** Once the file has arrived, log out of the server.<br />
** Copy the <code>.CRR</code> file to your local machine by typing: <code>scp <username>@147.86.8.26:/home/solsoc/from_soc/<IORG filename> /local/folder/</code> where <code>/local/folder/</code> is the location on your local machine where the file should be copied.<br />
** Unzip the <code>.CRR</code> and open it with a text editor.<br />
** Search for the <validity> tag and confirm the message says "Valid".<br />
*** If the .CRR file reports "Valid", then we are done!<br />
*** If it is not valid, more details of the errors will be listed. Create a new version of the IOR (remembering to iterate the version number) that fixes those errors and resubmit.<br />
<br />
== Including a Data Request in an IOR ==<br />
See [[How to Create a Data Request IOR]]</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=How_to_Create_an_IOR&diff=16453How to Create an IOR2024-06-18T09:34:04Z<p>Hualin: </p>
<hr />
<div>An IOR (Instrument Operations Response) is a series of instructions (telecommands) telling STIX what to do. An IOR is uploaded to STIX each STP cycle which is typically a week long. The process for uploading an IOR is as follows:<br />
# [[#Generate an IOR|Generate an IOR]];<br />
# [[#Test IOR on Ground Unit|Test IOR on Ground Unit]];<br />
# [[#Submit IOR for Internal Review|Submit IOR for Internal Review]]<br />
# [[#Submit IOR to SOC|Submit IOR to SOC]]<br />
Below focuses on article will focus on the first step, creating an IOR. For definitions of acronyms used in this page, see [[Acronyms & Definitions]].<br />
<br />
== Generate an IOR ==<br />
=== Required Software ===<br />
We suggest using STIX virtual server to generate IORs. <br />
The tutorial for logging onto the server can be found at<br />
<br />
https://v000658.fhnw.ch/index.php/s/7ADcnSNExFNPCyF<br />
<br />
If you create IORs with your local machine, you need to install starlet.<br />
<br />
* [[STIX-Starlet]]<br />
For instructions installing these packages, click on the package link above.<br />
<br />
=== How To Generate an IOR ===<br />
* Check the STP schedule on the [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/Cruise+Phase Solar Orbiter wiki]. GIVE BETTER INSTRUCTIONS ON HOW TO FIND THE RELEVANT INFO FROM THIS LINK. Take note of:<br />
** The STP number/cycle;<br />
** The deadline for IOR submission deadline to the Solar Orbiter SOC; GIVE INSTRUCTIONS ON HOW TO FIND THIS INFO IN THE TABLE VIA THE ABOVE LINK.<br />
** The onboard IOR start time (equivalent to the STP start time).<br />
* Log into [[SOOP KITCHEN]] and check whether there is an "analysis window" in the current STP. If there is an analysis window, we must include data requests as part of the IOR.<br />
** The start time, duration and end time of the STP/IOR can also be confirmed via [[SOOP KITCHEN]].<br />
* Download necessary input files. See nested bullets below. All can be found at https://pub023.cs.technik.fhnw.ch/gfts/solsoc/from_soc/ (This page is password protected. Contact Hualin at hualin.xiao@fhnw.ch to get access):<br />
** MIB:<br />
*** Check the current version number on [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/MIB+and+FOP Solar Orbiter wiki]. It is given by the "MIB Name" column.<br />
*** Ctrl+F the version number on the above pub023 web address and download.<br />
*** Unzip the file.<br />
** TMC:<br />
*** Provides constraints on data volume.<br />
*** Filename prefixed by TMC_ and suffixed by .xml.<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The TMC file for the correct LTP must be used otherwise Startlet will throw an error.<br />
*** There is one TMC per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Currently, although this file is required, STIX-Starlet does not extract information from this file. So we must check manually that the telemetry used by the IOR is within the telemetry allowance of the TMC file. Check this in SOOP Kitchen.<br />
** E-FECS<br />
*** Provides constraints on EMC<br />
*** Filename prefixed with EFECS_ and suffixed with .xml<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The EFECS file for the correct LTP must be used otherwise Startlet will throw an error.<br />
*** There is one EFECS per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Currently, STIX-Starlet does not extract information from this file. So we must check manually whether STIX must be in quiet mode any time during this IOR, i.e. must not use the motors. Check this in SOOP Kitchen.<br />
** JSON<br />
*** The JSON file contains certain info on the STP, e.g. the start and end time.<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The json file for the correct LTP must be used otherwise Startlet will not process the IOR correctly.<br />
*** There is one json per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Download latest version from the above pub023 URL. (The version here is usually the latest.)<br />
* Open [[STIX-Starlet]] and enter IOR metadata.<br />
** Set directory where IOR will be generated. Settings -> Set storage directory<br />
** Set Starlet to STIX format. Settings -> Instrument -> STIX<br />
** Enter the STP number from STP schedule into STP cycle field<br />
** Add your name in author field.<br />
** Add onboard start time from the STP schedule in the start time field.<br />
** End time must be before the next STP and next IOR starts (whichever is earliest), and after all telecommands have been executed. A typical value would be 24 hours after the IOR start time.<br />
** If this is the first IOR for the current STP, set the file and version numbers to 1.<br />
*** If an IOR has to be recreated due to an issue found in review, iterate version number.<br />
*** If more the STP requires more than one distinct IOR, iterate the file number<br />
* Enter the paths of the required files:<br />
** MiB: Settings -> Set instrument Database. Then select the unzipped MIB directory.<br />
** E-FECS & TMC: Click folder icon on the right of the value fields and select the relevant files.<br />
** JSON: Do the same as for E-FECS and TMC. DO NOT click "Load JSON" at this stage.<br />
* Add telecommands via the "Add Sequence".<br />
** STIX commands are prefixed at "AIX". Enter this is in the search field at the top to filter out non-STIX sequences.<br />
** See [[IOR Tips and Tricks]] for more advice.<br />
** In particular, see [[IOR Tips and Tricks#Time of First Telecommand|Time of First Telecommand]] for when to start the first telecommand of the IOR.<br />
** To include data requests in the IOR, see the section below on [[#Including a Data Request in an IOR|Including a Data Request in an IOR]]<br />
* Once all sequences are added, click "Load JSON" button. This will assign OBS ID to all telecommands. These should all be the same for a given STP.<br />
* Generate IOR by clicking "Generate" button. This will create a .SOL file in the "storage directory" set above.<br />
<br />
== Test IOR on Ground Unit ==<br />
* If you still have the IOR open in STIX-Starlet, save the IOR to as a <code>.tcl</code> by clicking the <code>.tcl</code> button in the toolbar.<br />
<br />
See [[Using the STIX Ground Unit#Testing an IOR with the Ground Unit|Testing an IOR with the Ground Unit]].<br />
<br />
== Submit IOR for Internal Review ==<br />
* Upload IOR .SOL file by clicking the "Upload IOR" button at https://pub023.cs.technik.fhnw.ch/view/operations<br />
* Email the link to the IOR overview to the STIX ops team.<br />
** The IOR overview URL can be found by locating the IOR at the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] and clicking the green button in the "Overview" column.<br />
<br />
== Submit IOR to SOC ==<br />
Once the STIX team is happy with the IOR, submit it to the SOC by doing the following:<br />
* Generate and download an IORG zip file corresponding to the IOR to be submitted.<br />
** Find the ID of the IOR from the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] on the STIX server.<br />
** Go to https://pub023.cs.technik.fhnw.ch/view/operations and click the button marked "Create IORG File".<br />
** Enter the ID of the first IOR into the start field and the ID of the last IOR to be included in the end field. Also enter the STP number and the IOR number (in most cases this is 1). Then click "Create and Download".<br />
* Send the IORG file to the SOC<br />
** You will need a server account write permissions. To get an account email Hualin at hualin.xiao@fhnw.ch or Dan Ryan at daniel.ryan@fhnw.ch<br />
** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Copy the IORG zip file to [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by opening a terminal and <code>cd</code> to the directory where you saved the IORG file above. Then type <code>sudo scp <IORG filename> <username>@147.86.8.26:~</code> where <code><IORG filename></code> is the name of the IORG file and <code><username></code> is the username of your account on the STIX GFTS server.<br />
** Login into the [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by typing <code>ssh <username>@147.86.8.26</code><br />
*** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Change permissions on the IORG file: <code>sudo chmod 777 <IORG filename></code><br />
** Move the IORG file from the home directory (where we copied it to above) to the <code>to_soc</code> directory by typing <code>sudo cp ~/<IORG filename> /home/solsoc/to_soc/</code><br />
* Confirm the SOC has validated the IOR<br />
** The SOC will copy the file from the <code>to_soc</code> and then delete it. This can happen straight away. The SOC will then run an automatically verify the IOR and then return a <code>.CRR</code> back to the <code>/home/solsoc/from_soc</code> directory within 10 minutes.<br />
** <code>cd</code> to the <code>home/solsoc/from_soc</code> and wait for the <code>.CRR</code> to appear. It will have the same filename as the submitted IORG file, but with a <code>.CRR</code> extension.<br />
** Once the file has arrived, log out of the server.<br />
** Copy the <code>.CRR</code> file to your local machine by typing: <code>scp <username>@147.86.8.26:/home/solsoc/from_soc/<IORG filename> /local/folder/</code> where <code>/local/folder/</code> is the location on your local machine where the file should be copied.<br />
** Unzip the <code>.CRR</code> and open it with a text editor.<br />
** Search for the <validity> tag and confirm the message says "Valid".<br />
*** If the .CRR file reports "Valid", then we are done!<br />
*** If it is not valid, more details of the errors will be listed. Create a new version of the IOR (remembering to iterate the version number) that fixes those errors and resubmit.<br />
<br />
== Including a Data Request in an IOR ==<br />
See [[How to Create a Data Request IOR]]</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=How_to_Create_an_IOR&diff=16451How to Create an IOR2024-06-18T09:33:52Z<p>Hualin: </p>
<hr />
<div>An IOR (Instrument Operations Response) is a series of instructions (telecommands) telling STIX what to do. An IOR is uploaded to STIX each STP cycle which is typically a week long. The process for uploading an IOR is as follows:<br />
# [[#Generate an IOR|Generate an IOR]];<br />
# [[#Test IOR on Ground Unit|Test IOR on Ground Unit]];<br />
# [[#Submit IOR for Internal Review|Submit IOR for Internal Review]]<br />
# [[#Submit IOR to SOC|Submit IOR to SOC]]<br />
Below focuses on article will focus on the first step, creating an IOR. For definitions of acronyms used in this page, see [[Acronyms & Definitions]].<br />
<br />
== Generate an IOR ==<br />
=== Required Software ===<br />
We suggest using STIX virtual server to generate IORs. <br />
The tutorial for logging onto the server can be found at<br />
https://v000658.fhnw.ch/index.php/s/7ADcnSNExFNPCyF<br />
<br />
If you create IORs with your local machine, you need to install starlet.<br />
<br />
* [[STIX-Starlet]]<br />
For instructions installing these packages, click on the package link above.<br />
<br />
=== How To Generate an IOR ===<br />
* Check the STP schedule on the [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/Cruise+Phase Solar Orbiter wiki]. GIVE BETTER INSTRUCTIONS ON HOW TO FIND THE RELEVANT INFO FROM THIS LINK. Take note of:<br />
** The STP number/cycle;<br />
** The deadline for IOR submission deadline to the Solar Orbiter SOC; GIVE INSTRUCTIONS ON HOW TO FIND THIS INFO IN THE TABLE VIA THE ABOVE LINK.<br />
** The onboard IOR start time (equivalent to the STP start time).<br />
* Log into [[SOOP KITCHEN]] and check whether there is an "analysis window" in the current STP. If there is an analysis window, we must include data requests as part of the IOR.<br />
** The start time, duration and end time of the STP/IOR can also be confirmed via [[SOOP KITCHEN]].<br />
* Download necessary input files. See nested bullets below. All can be found at https://pub023.cs.technik.fhnw.ch/gfts/solsoc/from_soc/ (This page is password protected. Contact Hualin at hualin.xiao@fhnw.ch to get access):<br />
** MIB:<br />
*** Check the current version number on [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/MIB+and+FOP Solar Orbiter wiki]. It is given by the "MIB Name" column.<br />
*** Ctrl+F the version number on the above pub023 web address and download.<br />
*** Unzip the file.<br />
** TMC:<br />
*** Provides constraints on data volume.<br />
*** Filename prefixed by TMC_ and suffixed by .xml.<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The TMC file for the correct LTP must be used otherwise Startlet will throw an error.<br />
*** There is one TMC per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Currently, although this file is required, STIX-Starlet does not extract information from this file. So we must check manually that the telemetry used by the IOR is within the telemetry allowance of the TMC file. Check this in SOOP Kitchen.<br />
** E-FECS<br />
*** Provides constraints on EMC<br />
*** Filename prefixed with EFECS_ and suffixed with .xml<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The EFECS file for the correct LTP must be used otherwise Startlet will throw an error.<br />
*** There is one EFECS per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Currently, STIX-Starlet does not extract information from this file. So we must check manually whether STIX must be in quiet mode any time during this IOR, i.e. must not use the motors. Check this in SOOP Kitchen.<br />
** JSON<br />
*** The JSON file contains certain info on the STP, e.g. the start and end time.<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The json file for the correct LTP must be used otherwise Startlet will not process the IOR correctly.<br />
*** There is one json per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Download latest version from the above pub023 URL. (The version here is usually the latest.)<br />
* Open [[STIX-Starlet]] and enter IOR metadata.<br />
** Set directory where IOR will be generated. Settings -> Set storage directory<br />
** Set Starlet to STIX format. Settings -> Instrument -> STIX<br />
** Enter the STP number from STP schedule into STP cycle field<br />
** Add your name in author field.<br />
** Add onboard start time from the STP schedule in the start time field.<br />
** End time must be before next STP starts and after all telecommands have been executed. A typical value would be 24 hours after the IOR start time.<br />
** If this is the first IOR for the current STP, set the file and version numbers to 1.<br />
*** If an IOR has to be recreated due to an issue found in review, iterate version number.<br />
*** If more the STP requires more than one distinct IOR, iterate the file number<br />
* Enter the paths of the required files:<br />
** MiB: Settings -> Set instrument Database. Then select the unzipped MIB directory.<br />
** E-FECS & TMC: Click folder icon on the right of the value fields and select the relevant files.<br />
** JSON: Do the same as for E-FECS and TMC. DO NOT click "Load JSON" at this stage.<br />
* Add telecommands via the "Add Sequence".<br />
** STIX commands are prefixed at "AIX". Enter this is in the search field at the top to filter out non-STIX sequences.<br />
** See [[IOR Tips and Tricks]] for more advice.<br />
** In particular, see [[IOR Tips and Tricks#Time of First Telecommand|Time of First Telecommand]] for when to start the first telecommand of the IOR.<br />
** To include data requests in the IOR, see the section below on [[#Including a Data Request in an IOR|Including a Data Request in an IOR]]<br />
* Once all sequences are added, click "Load JSON" button. This will assign OBS ID to all telecommands. These should all be the same for a given STP.<br />
* Generate IOR by clicking "Generate" button. This will create a .SOL file in the "storage directory" set above.<br />
<br />
== Test IOR on Ground Unit ==<br />
* If you still have the IOR open in STIX-Starlet, save the IOR to as a <code>.tcl</code> by clicking the <code>.tcl</code> button in the toolbar.<br />
<br />
See [[Using the STIX Ground Unit#Testing an IOR with the Ground Unit|Testing an IOR with the Ground Unit]].<br />
<br />
== Submit IOR for Internal Review ==<br />
* Upload IOR .SOL file by clicking the "Upload IOR" button at https://pub023.cs.technik.fhnw.ch/view/operations<br />
* Email the link to the IOR overview to the STIX ops team.<br />
** The IOR overview URL can be found by locating the IOR at the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] and clicking the green button in the "Overview" column.<br />
<br />
== Submit IOR to SOC ==<br />
Once the STIX team is happy with the IOR, submit it to the SOC by doing the following:<br />
* Generate and download an IORG zip file corresponding to the IOR to be submitted.<br />
** Find the ID of the IOR from the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] on the STIX server.<br />
** Go to https://pub023.cs.technik.fhnw.ch/view/operations and click the button marked "Create IORG File".<br />
** Enter the ID of the first IOR into the start field and the ID of the last IOR to be included in the end field. Also enter the STP number and the IOR number (in most cases this is 1). Then click "Create and Download".<br />
* Send the IORG file to the SOC<br />
** You will need a server account write permissions. To get an account email Hualin at hualin.xiao@fhnw.ch or Dan Ryan at daniel.ryan@fhnw.ch<br />
** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Copy the IORG zip file to [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by opening a terminal and <code>cd</code> to the directory where you saved the IORG file above. Then type <code>sudo scp <IORG filename> <username>@147.86.8.26:~</code> where <code><IORG filename></code> is the name of the IORG file and <code><username></code> is the username of your account on the STIX GFTS server.<br />
** Login into the [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by typing <code>ssh <username>@147.86.8.26</code><br />
*** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Change permissions on the IORG file: <code>sudo chmod 777 <IORG filename></code><br />
** Move the IORG file from the home directory (where we copied it to above) to the <code>to_soc</code> directory by typing <code>sudo cp ~/<IORG filename> /home/solsoc/to_soc/</code><br />
* Confirm the SOC has validated the IOR<br />
** The SOC will copy the file from the <code>to_soc</code> and then delete it. This can happen straight away. The SOC will then run an automatically verify the IOR and then return a <code>.CRR</code> back to the <code>/home/solsoc/from_soc</code> directory within 10 minutes.<br />
** <code>cd</code> to the <code>home/solsoc/from_soc</code> and wait for the <code>.CRR</code> to appear. It will have the same filename as the submitted IORG file, but with a <code>.CRR</code> extension.<br />
** Once the file has arrived, log out of the server.<br />
** Copy the <code>.CRR</code> file to your local machine by typing: <code>scp <username>@147.86.8.26:/home/solsoc/from_soc/<IORG filename> /local/folder/</code> where <code>/local/folder/</code> is the location on your local machine where the file should be copied.<br />
** Unzip the <code>.CRR</code> and open it with a text editor.<br />
** Search for the <validity> tag and confirm the message says "Valid".<br />
*** If the .CRR file reports "Valid", then we are done!<br />
*** If it is not valid, more details of the errors will be listed. Create a new version of the IOR (remembering to iterate the version number) that fixes those errors and resubmit.<br />
<br />
== Including a Data Request in an IOR ==<br />
See [[How to Create a Data Request IOR]]</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=How_to_Create_an_IOR&diff=16450How to Create an IOR2024-06-18T09:33:41Z<p>Hualin: </p>
<hr />
<div>An IOR (Instrument Operations Response) is a series of instructions (telecommands) telling STIX what to do. An IOR is uploaded to STIX each STP cycle which is typically a week long. The process for uploading an IOR is as follows:<br />
# [[#Generate an IOR|Generate an IOR]];<br />
# [[#Test IOR on Ground Unit|Test IOR on Ground Unit]];<br />
# [[#Submit IOR for Internal Review|Submit IOR for Internal Review]]<br />
# [[#Submit IOR to SOC|Submit IOR to SOC]]<br />
Below focuses on article will focus on the first step, creating an IOR. For definitions of acronyms used in this page, see [[Acronyms & Definitions]].<br />
<br />
== Generate an IOR ==<br />
=== Required Software ===<br />
We suggest using STIX virtual server to generate IORs. The tutorial for logging onto the server can be found at<br />
https://v000658.fhnw.ch/index.php/s/7ADcnSNExFNPCyF<br />
<br />
If you create IORs with your local machine, you need to install starlet.<br />
<br />
* [[STIX-Starlet]]<br />
For instructions installing these packages, click on the package link above.<br />
<br />
=== How To Generate an IOR ===<br />
* Check the STP schedule on the [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/Cruise+Phase Solar Orbiter wiki]. GIVE BETTER INSTRUCTIONS ON HOW TO FIND THE RELEVANT INFO FROM THIS LINK. Take note of:<br />
** The STP number/cycle;<br />
** The deadline for IOR submission deadline to the Solar Orbiter SOC; GIVE INSTRUCTIONS ON HOW TO FIND THIS INFO IN THE TABLE VIA THE ABOVE LINK.<br />
** The onboard IOR start time (equivalent to the STP start time).<br />
* Log into [[SOOP KITCHEN]] and check whether there is an "analysis window" in the current STP. If there is an analysis window, we must include data requests as part of the IOR.<br />
** The start time, duration and end time of the STP/IOR can also be confirmed via [[SOOP KITCHEN]].<br />
* Download necessary input files. See nested bullets below. All can be found at https://pub023.cs.technik.fhnw.ch/gfts/solsoc/from_soc/ (This page is password protected. Contact Hualin at hualin.xiao@fhnw.ch to get access):<br />
** MIB:<br />
*** Check the current version number on [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/MIB+and+FOP Solar Orbiter wiki]. It is given by the "MIB Name" column.<br />
*** Ctrl+F the version number on the above pub023 web address and download.<br />
*** Unzip the file.<br />
** TMC:<br />
*** Provides constraints on data volume.<br />
*** Filename prefixed by TMC_ and suffixed by .xml.<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The TMC file for the correct LTP must be used otherwise Startlet will throw an error.<br />
*** There is one TMC per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Currently, although this file is required, STIX-Starlet does not extract information from this file. So we must check manually that the telemetry used by the IOR is within the telemetry allowance of the TMC file. Check this in SOOP Kitchen.<br />
** E-FECS<br />
*** Provides constraints on EMC<br />
*** Filename prefixed with EFECS_ and suffixed with .xml<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The EFECS file for the correct LTP must be used otherwise Startlet will throw an error.<br />
*** There is one EFECS per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Currently, STIX-Starlet does not extract information from this file. So we must check manually whether STIX must be in quiet mode any time during this IOR, i.e. must not use the motors. Check this in SOOP Kitchen.<br />
** JSON<br />
*** The JSON file contains certain info on the STP, e.g. the start and end time.<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The json file for the correct LTP must be used otherwise Startlet will not process the IOR correctly.<br />
*** There is one json per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Download latest version from the above pub023 URL. (The version here is usually the latest.)<br />
* Open [[STIX-Starlet]] and enter IOR metadata.<br />
** Set directory where IOR will be generated. Settings -> Set storage directory<br />
** Set Starlet to STIX format. Settings -> Instrument -> STIX<br />
** Enter the STP number from STP schedule into STP cycle field<br />
** Add your name in author field.<br />
** Add onboard start time from the STP schedule in the start time field.<br />
** End time must be before next STP starts and after all telecommands have been executed. A typical value would be 24 hours after the IOR start time.<br />
** If this is the first IOR for the current STP, set the file and version numbers to 1.<br />
*** If an IOR has to be recreated due to an issue found in review, iterate version number.<br />
*** If more the STP requires more than one distinct IOR, iterate the file number<br />
* Enter the paths of the required files:<br />
** MiB: Settings -> Set instrument Database. Then select the unzipped MIB directory.<br />
** E-FECS & TMC: Click folder icon on the right of the value fields and select the relevant files.<br />
** JSON: Do the same as for E-FECS and TMC. DO NOT click "Load JSON" at this stage.<br />
* Add telecommands via the "Add Sequence".<br />
** STIX commands are prefixed at "AIX". Enter this is in the search field at the top to filter out non-STIX sequences.<br />
** See [[IOR Tips and Tricks]] for more advice.<br />
** In particular, see [[IOR Tips and Tricks#Time of First Telecommand|Time of First Telecommand]] for when to start the first telecommand of the IOR.<br />
** To include data requests in the IOR, see the section below on [[#Including a Data Request in an IOR|Including a Data Request in an IOR]]<br />
* Once all sequences are added, click "Load JSON" button. This will assign OBS ID to all telecommands. These should all be the same for a given STP.<br />
* Generate IOR by clicking "Generate" button. This will create a .SOL file in the "storage directory" set above.<br />
<br />
== Test IOR on Ground Unit ==<br />
* If you still have the IOR open in STIX-Starlet, save the IOR to as a <code>.tcl</code> by clicking the <code>.tcl</code> button in the toolbar.<br />
<br />
See [[Using the STIX Ground Unit#Testing an IOR with the Ground Unit|Testing an IOR with the Ground Unit]].<br />
<br />
== Submit IOR for Internal Review ==<br />
* Upload IOR .SOL file by clicking the "Upload IOR" button at https://pub023.cs.technik.fhnw.ch/view/operations<br />
* Email the link to the IOR overview to the STIX ops team.<br />
** The IOR overview URL can be found by locating the IOR at the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] and clicking the green button in the "Overview" column.<br />
<br />
== Submit IOR to SOC ==<br />
Once the STIX team is happy with the IOR, submit it to the SOC by doing the following:<br />
* Generate and download an IORG zip file corresponding to the IOR to be submitted.<br />
** Find the ID of the IOR from the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] on the STIX server.<br />
** Go to https://pub023.cs.technik.fhnw.ch/view/operations and click the button marked "Create IORG File".<br />
** Enter the ID of the first IOR into the start field and the ID of the last IOR to be included in the end field. Also enter the STP number and the IOR number (in most cases this is 1). Then click "Create and Download".<br />
* Send the IORG file to the SOC<br />
** You will need a server account write permissions. To get an account email Hualin at hualin.xiao@fhnw.ch or Dan Ryan at daniel.ryan@fhnw.ch<br />
** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Copy the IORG zip file to [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by opening a terminal and <code>cd</code> to the directory where you saved the IORG file above. Then type <code>sudo scp <IORG filename> <username>@147.86.8.26:~</code> where <code><IORG filename></code> is the name of the IORG file and <code><username></code> is the username of your account on the STIX GFTS server.<br />
** Login into the [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by typing <code>ssh <username>@147.86.8.26</code><br />
*** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Change permissions on the IORG file: <code>sudo chmod 777 <IORG filename></code><br />
** Move the IORG file from the home directory (where we copied it to above) to the <code>to_soc</code> directory by typing <code>sudo cp ~/<IORG filename> /home/solsoc/to_soc/</code><br />
* Confirm the SOC has validated the IOR<br />
** The SOC will copy the file from the <code>to_soc</code> and then delete it. This can happen straight away. The SOC will then run an automatically verify the IOR and then return a <code>.CRR</code> back to the <code>/home/solsoc/from_soc</code> directory within 10 minutes.<br />
** <code>cd</code> to the <code>home/solsoc/from_soc</code> and wait for the <code>.CRR</code> to appear. It will have the same filename as the submitted IORG file, but with a <code>.CRR</code> extension.<br />
** Once the file has arrived, log out of the server.<br />
** Copy the <code>.CRR</code> file to your local machine by typing: <code>scp <username>@147.86.8.26:/home/solsoc/from_soc/<IORG filename> /local/folder/</code> where <code>/local/folder/</code> is the location on your local machine where the file should be copied.<br />
** Unzip the <code>.CRR</code> and open it with a text editor.<br />
** Search for the <validity> tag and confirm the message says "Valid".<br />
*** If the .CRR file reports "Valid", then we are done!<br />
*** If it is not valid, more details of the errors will be listed. Create a new version of the IOR (remembering to iterate the version number) that fixes those errors and resubmit.<br />
<br />
== Including a Data Request in an IOR ==<br />
See [[How to Create a Data Request IOR]]</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=How_to_Create_an_IOR&diff=16449How to Create an IOR2024-06-18T09:29:45Z<p>Hualin: </p>
<hr />
<div>An IOR (Instrument Operations Response) is a series of instructions (telecommands) telling STIX what to do. An IOR is uploaded to STIX each STP cycle which is typically a week long. The process for uploading an IOR is as follows:<br />
# [[#Generate an IOR|Generate an IOR]];<br />
# [[#Test IOR on Ground Unit|Test IOR on Ground Unit]];<br />
# [[#Submit IOR for Internal Review|Submit IOR for Internal Review]]<br />
# [[#Submit IOR to SOC|Submit IOR to SOC]]<br />
Below focuses on article will focus on the first step, creating an IOR. For definitions of acronyms used in this page, see [[Acronyms & Definitions]].<br />
<br />
== Generate an IOR ==<br />
=== Required Software ===<br />
If you use the virtual machine for STIX operations, you can skip this step.<br />
To create an IOR you will need to install the following software tools:<br />
* [[STIX-Starlet]]<br />
For instructions installing these packages, click on the package link above.<br />
<br />
=== How To Generate an IOR ===<br />
* Check the STP schedule on the [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/Cruise+Phase Solar Orbiter wiki]. GIVE BETTER INSTRUCTIONS ON HOW TO FIND THE RELEVANT INFO FROM THIS LINK. Take note of:<br />
** The STP number/cycle;<br />
** The deadline for IOR submission deadline to the Solar Orbiter SOC; GIVE INSTRUCTIONS ON HOW TO FIND THIS INFO IN THE TABLE VIA THE ABOVE LINK.<br />
** The onboard IOR start time (equivalent to the STP start time).<br />
* Log into [[SOOP KITCHEN]] and check whether there is an "analysis window" in the current STP. If there is an analysis window, we must include data requests as part of the IOR.<br />
** The start time, duration and end time of the STP/IOR can also be confirmed via [[SOOP KITCHEN]].<br />
* Download necessary input files. See nested bullets below. All can be found at https://pub023.cs.technik.fhnw.ch/gfts/solsoc/from_soc/ (This page is password protected. Contact Hualin at hualin.xiao@fhnw.ch to get access):<br />
** MIB:<br />
*** Check the current version number on [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/MIB+and+FOP Solar Orbiter wiki]. It is given by the "MIB Name" column.<br />
*** Ctrl+F the version number on the above pub023 web address and download.<br />
*** Unzip the file.<br />
** TMC:<br />
*** Provides constraints on data volume.<br />
*** Filename prefixed by TMC_ and suffixed by .xml.<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The TMC file for the correct LTP must be used otherwise Startlet will throw an error.<br />
*** There is one TMC per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Currently, although this file is required, STIX-Starlet does not extract information from this file. So we must check manually that the telemetry used by the IOR is within the telemetry allowance of the TMC file. Check this in SOOP Kitchen.<br />
** E-FECS<br />
*** Provides constraints on EMC<br />
*** Filename prefixed with EFECS_ and suffixed with .xml<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The EFECS file for the correct LTP must be used otherwise Startlet will throw an error.<br />
*** There is one EFECS per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Currently, STIX-Starlet does not extract information from this file. So we must check manually whether STIX must be in quiet mode any time during this IOR, i.e. must not use the motors. Check this in SOOP Kitchen.<br />
** JSON<br />
*** The JSON file contains certain info on the STP, e.g. the start and end time.<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The json file for the correct LTP must be used otherwise Startlet will not process the IOR correctly.<br />
*** There is one json per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Download latest version from the above pub023 URL. (The version here is usually the latest.)<br />
* Open [[STIX-Starlet]] and enter IOR metadata.<br />
** Set directory where IOR will be generated. Settings -> Set storage directory<br />
** Set Starlet to STIX format. Settings -> Instrument -> STIX<br />
** Enter the STP number from STP schedule into STP cycle field<br />
** Add your name in author field.<br />
** Add onboard start time from the STP schedule in the start time field.<br />
** End time must be before next STP starts and after all telecommands have been executed. A typical value would be 24 hours after the IOR start time.<br />
** If this is the first IOR for the current STP, set the file and version numbers to 1.<br />
*** If an IOR has to be recreated due to an issue found in review, iterate version number.<br />
*** If more the STP requires more than one distinct IOR, iterate the file number<br />
* Enter the paths of the required files:<br />
** MiB: Settings -> Set instrument Database. Then select the unzipped MIB directory.<br />
** E-FECS & TMC: Click folder icon on the right of the value fields and select the relevant files.<br />
** JSON: Do the same as for E-FECS and TMC. DO NOT click "Load JSON" at this stage.<br />
* Add telecommands via the "Add Sequence".<br />
** STIX commands are prefixed at "AIX". Enter this is in the search field at the top to filter out non-STIX sequences.<br />
** See [[IOR Tips and Tricks]] for more advice.<br />
** In particular, see [[IOR Tips and Tricks#Time of First Telecommand|Time of First Telecommand]] for when to start the first telecommand of the IOR.<br />
** To include data requests in the IOR, see the section below on [[#Including a Data Request in an IOR|Including a Data Request in an IOR]]<br />
* Once all sequences are added, click "Load JSON" button. This will assign OBS ID to all telecommands. These should all be the same for a given STP.<br />
* Generate IOR by clicking "Generate" button. This will create a .SOL file in the "storage directory" set above.<br />
<br />
== Test IOR on Ground Unit ==<br />
* If you still have the IOR open in STIX-Starlet, save the IOR to as a <code>.tcl</code> by clicking the <code>.tcl</code> button in the toolbar.<br />
<br />
See [[Using the STIX Ground Unit#Testing an IOR with the Ground Unit|Testing an IOR with the Ground Unit]].<br />
<br />
== Submit IOR for Internal Review ==<br />
* Upload IOR .SOL file by clicking the "Upload IOR" button at https://pub023.cs.technik.fhnw.ch/view/operations<br />
* Email the link to the IOR overview to the STIX ops team.<br />
** The IOR overview URL can be found by locating the IOR at the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] and clicking the green button in the "Overview" column.<br />
<br />
== Submit IOR to SOC ==<br />
Once the STIX team is happy with the IOR, submit it to the SOC by doing the following:<br />
* Generate and download an IORG zip file corresponding to the IOR to be submitted.<br />
** Find the ID of the IOR from the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] on the STIX server.<br />
** Go to https://pub023.cs.technik.fhnw.ch/view/operations and click the button marked "Create IORG File".<br />
** Enter the ID of the first IOR into the start field and the ID of the last IOR to be included in the end field. Also enter the STP number and the IOR number (in most cases this is 1). Then click "Create and Download".<br />
* Send the IORG file to the SOC<br />
** You will need a server account write permissions. To get an account email Hualin at hualin.xiao@fhnw.ch or Dan Ryan at daniel.ryan@fhnw.ch<br />
** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Copy the IORG zip file to [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by opening a terminal and <code>cd</code> to the directory where you saved the IORG file above. Then type <code>sudo scp <IORG filename> <username>@147.86.8.26:~</code> where <code><IORG filename></code> is the name of the IORG file and <code><username></code> is the username of your account on the STIX GFTS server.<br />
** Login into the [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by typing <code>ssh <username>@147.86.8.26</code><br />
*** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Change permissions on the IORG file: <code>sudo chmod 777 <IORG filename></code><br />
** Move the IORG file from the home directory (where we copied it to above) to the <code>to_soc</code> directory by typing <code>sudo cp ~/<IORG filename> /home/solsoc/to_soc/</code><br />
* Confirm the SOC has validated the IOR<br />
** The SOC will copy the file from the <code>to_soc</code> and then delete it. This can happen straight away. The SOC will then run an automatically verify the IOR and then return a <code>.CRR</code> back to the <code>/home/solsoc/from_soc</code> directory within 10 minutes.<br />
** <code>cd</code> to the <code>home/solsoc/from_soc</code> and wait for the <code>.CRR</code> to appear. It will have the same filename as the submitted IORG file, but with a <code>.CRR</code> extension.<br />
** Once the file has arrived, log out of the server.<br />
** Copy the <code>.CRR</code> file to your local machine by typing: <code>scp <username>@147.86.8.26:/home/solsoc/from_soc/<IORG filename> /local/folder/</code> where <code>/local/folder/</code> is the location on your local machine where the file should be copied.<br />
** Unzip the <code>.CRR</code> and open it with a text editor.<br />
** Search for the <validity> tag and confirm the message says "Valid".<br />
*** If the .CRR file reports "Valid", then we are done!<br />
*** If it is not valid, more details of the errors will be listed. Create a new version of the IOR (remembering to iterate the version number) that fixes those errors and resubmit.<br />
<br />
== Including a Data Request in an IOR ==<br />
See [[How to Create a Data Request IOR]]</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=How_to_Create_an_IOR&diff=16448How to Create an IOR2024-06-18T09:29:36Z<p>Hualin: </p>
<hr />
<div>An IOR (Instrument Operations Response) is a series of instructions (telecommands) telling STIX what to do. An IOR is uploaded to STIX each STP cycle which is typically a week long. The process for uploading an IOR is as follows:<br />
# [[#Generate an IOR|Generate an IOR]];<br />
# [[#Test IOR on Ground Unit|Test IOR on Ground Unit]];<br />
# [[#Submit IOR for Internal Review|Submit IOR for Internal Review]]<br />
# [[#Submit IOR to SOC|Submit IOR to SOC]]<br />
Below focuses on article will focus on the first step, creating an IOR. For definitions of acronyms used in this page, see [[Acronyms & Definitions]].<br />
<br />
== Generate an IOR ==<br />
=== Required Software ===<br />
If you use the virtual machine for STIX operations, you can skip this step.<br />
<br />
<br />
To create an IOR you will need to install the following software tools:<br />
* [[STIX-Starlet]]<br />
For instructions installing these packages, click on the package link above.<br />
<br />
=== How To Generate an IOR ===<br />
* Check the STP schedule on the [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/Cruise+Phase Solar Orbiter wiki]. GIVE BETTER INSTRUCTIONS ON HOW TO FIND THE RELEVANT INFO FROM THIS LINK. Take note of:<br />
** The STP number/cycle;<br />
** The deadline for IOR submission deadline to the Solar Orbiter SOC; GIVE INSTRUCTIONS ON HOW TO FIND THIS INFO IN THE TABLE VIA THE ABOVE LINK.<br />
** The onboard IOR start time (equivalent to the STP start time).<br />
* Log into [[SOOP KITCHEN]] and check whether there is an "analysis window" in the current STP. If there is an analysis window, we must include data requests as part of the IOR.<br />
** The start time, duration and end time of the STP/IOR can also be confirmed via [[SOOP KITCHEN]].<br />
* Download necessary input files. See nested bullets below. All can be found at https://pub023.cs.technik.fhnw.ch/gfts/solsoc/from_soc/ (This page is password protected. Contact Hualin at hualin.xiao@fhnw.ch to get access):<br />
** MIB:<br />
*** Check the current version number on [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/MIB+and+FOP Solar Orbiter wiki]. It is given by the "MIB Name" column.<br />
*** Ctrl+F the version number on the above pub023 web address and download.<br />
*** Unzip the file.<br />
** TMC:<br />
*** Provides constraints on data volume.<br />
*** Filename prefixed by TMC_ and suffixed by .xml.<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The TMC file for the correct LTP must be used otherwise Startlet will throw an error.<br />
*** There is one TMC per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Currently, although this file is required, STIX-Starlet does not extract information from this file. So we must check manually that the telemetry used by the IOR is within the telemetry allowance of the TMC file. Check this in SOOP Kitchen.<br />
** E-FECS<br />
*** Provides constraints on EMC<br />
*** Filename prefixed with EFECS_ and suffixed with .xml<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The EFECS file for the correct LTP must be used otherwise Startlet will throw an error.<br />
*** There is one EFECS per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Currently, STIX-Starlet does not extract information from this file. So we must check manually whether STIX must be in quiet mode any time during this IOR, i.e. must not use the motors. Check this in SOOP Kitchen.<br />
** JSON<br />
*** The JSON file contains certain info on the STP, e.g. the start and end time.<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The json file for the correct LTP must be used otherwise Startlet will not process the IOR correctly.<br />
*** There is one json per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Download latest version from the above pub023 URL. (The version here is usually the latest.)<br />
* Open [[STIX-Starlet]] and enter IOR metadata.<br />
** Set directory where IOR will be generated. Settings -> Set storage directory<br />
** Set Starlet to STIX format. Settings -> Instrument -> STIX<br />
** Enter the STP number from STP schedule into STP cycle field<br />
** Add your name in author field.<br />
** Add onboard start time from the STP schedule in the start time field.<br />
** End time must be before next STP starts and after all telecommands have been executed. A typical value would be 24 hours after the IOR start time.<br />
** If this is the first IOR for the current STP, set the file and version numbers to 1.<br />
*** If an IOR has to be recreated due to an issue found in review, iterate version number.<br />
*** If more the STP requires more than one distinct IOR, iterate the file number<br />
* Enter the paths of the required files:<br />
** MiB: Settings -> Set instrument Database. Then select the unzipped MIB directory.<br />
** E-FECS & TMC: Click folder icon on the right of the value fields and select the relevant files.<br />
** JSON: Do the same as for E-FECS and TMC. DO NOT click "Load JSON" at this stage.<br />
* Add telecommands via the "Add Sequence".<br />
** STIX commands are prefixed at "AIX". Enter this is in the search field at the top to filter out non-STIX sequences.<br />
** See [[IOR Tips and Tricks]] for more advice.<br />
** In particular, see [[IOR Tips and Tricks#Time of First Telecommand|Time of First Telecommand]] for when to start the first telecommand of the IOR.<br />
** To include data requests in the IOR, see the section below on [[#Including a Data Request in an IOR|Including a Data Request in an IOR]]<br />
* Once all sequences are added, click "Load JSON" button. This will assign OBS ID to all telecommands. These should all be the same for a given STP.<br />
* Generate IOR by clicking "Generate" button. This will create a .SOL file in the "storage directory" set above.<br />
<br />
== Test IOR on Ground Unit ==<br />
* If you still have the IOR open in STIX-Starlet, save the IOR to as a <code>.tcl</code> by clicking the <code>.tcl</code> button in the toolbar.<br />
<br />
See [[Using the STIX Ground Unit#Testing an IOR with the Ground Unit|Testing an IOR with the Ground Unit]].<br />
<br />
== Submit IOR for Internal Review ==<br />
* Upload IOR .SOL file by clicking the "Upload IOR" button at https://pub023.cs.technik.fhnw.ch/view/operations<br />
* Email the link to the IOR overview to the STIX ops team.<br />
** The IOR overview URL can be found by locating the IOR at the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] and clicking the green button in the "Overview" column.<br />
<br />
== Submit IOR to SOC ==<br />
Once the STIX team is happy with the IOR, submit it to the SOC by doing the following:<br />
* Generate and download an IORG zip file corresponding to the IOR to be submitted.<br />
** Find the ID of the IOR from the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] on the STIX server.<br />
** Go to https://pub023.cs.technik.fhnw.ch/view/operations and click the button marked "Create IORG File".<br />
** Enter the ID of the first IOR into the start field and the ID of the last IOR to be included in the end field. Also enter the STP number and the IOR number (in most cases this is 1). Then click "Create and Download".<br />
* Send the IORG file to the SOC<br />
** You will need a server account write permissions. To get an account email Hualin at hualin.xiao@fhnw.ch or Dan Ryan at daniel.ryan@fhnw.ch<br />
** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Copy the IORG zip file to [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by opening a terminal and <code>cd</code> to the directory where you saved the IORG file above. Then type <code>sudo scp <IORG filename> <username>@147.86.8.26:~</code> where <code><IORG filename></code> is the name of the IORG file and <code><username></code> is the username of your account on the STIX GFTS server.<br />
** Login into the [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by typing <code>ssh <username>@147.86.8.26</code><br />
*** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Change permissions on the IORG file: <code>sudo chmod 777 <IORG filename></code><br />
** Move the IORG file from the home directory (where we copied it to above) to the <code>to_soc</code> directory by typing <code>sudo cp ~/<IORG filename> /home/solsoc/to_soc/</code><br />
* Confirm the SOC has validated the IOR<br />
** The SOC will copy the file from the <code>to_soc</code> and then delete it. This can happen straight away. The SOC will then run an automatically verify the IOR and then return a <code>.CRR</code> back to the <code>/home/solsoc/from_soc</code> directory within 10 minutes.<br />
** <code>cd</code> to the <code>home/solsoc/from_soc</code> and wait for the <code>.CRR</code> to appear. It will have the same filename as the submitted IORG file, but with a <code>.CRR</code> extension.<br />
** Once the file has arrived, log out of the server.<br />
** Copy the <code>.CRR</code> file to your local machine by typing: <code>scp <username>@147.86.8.26:/home/solsoc/from_soc/<IORG filename> /local/folder/</code> where <code>/local/folder/</code> is the location on your local machine where the file should be copied.<br />
** Unzip the <code>.CRR</code> and open it with a text editor.<br />
** Search for the <validity> tag and confirm the message says "Valid".<br />
*** If the .CRR file reports "Valid", then we are done!<br />
*** If it is not valid, more details of the errors will be listed. Create a new version of the IOR (remembering to iterate the version number) that fixes those errors and resubmit.<br />
<br />
== Including a Data Request in an IOR ==<br />
See [[How to Create a Data Request IOR]]</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=How_to_Create_an_IOR&diff=16447How to Create an IOR2024-06-18T09:29:21Z<p>Hualin: /* Required Software */</p>
<hr />
<div>An IOR (Instrument Operations Response) is a series of instructions (telecommands) telling STIX what to do. An IOR is uploaded to STIX each STP cycle which is typically a week long. The process for uploading an IOR is as follows:<br />
# [[#Generate an IOR|Generate an IOR]];<br />
# [[#Test IOR on Ground Unit|Test IOR on Ground Unit]];<br />
# [[#Submit IOR for Internal Review|Submit IOR for Internal Review]]<br />
# [[#Submit IOR to SOC|Submit IOR to SOC]]<br />
Below focuses on article will focus on the first step, creating an IOR. For definitions of acronyms used in this page, see [[Acronyms & Definitions]].<br />
<br />
== Generate an IOR ==<br />
=== Required Software ===<br />
If you use the virtual machine for STIX operations, you can skip this step<br />
<br />
To create an IOR you will need to install the following software tools:<br />
* [[STIX-Starlet]]<br />
For instructions installing these packages, click on the package link above.<br />
<br />
=== How To Generate an IOR ===<br />
* Check the STP schedule on the [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/Cruise+Phase Solar Orbiter wiki]. GIVE BETTER INSTRUCTIONS ON HOW TO FIND THE RELEVANT INFO FROM THIS LINK. Take note of:<br />
** The STP number/cycle;<br />
** The deadline for IOR submission deadline to the Solar Orbiter SOC; GIVE INSTRUCTIONS ON HOW TO FIND THIS INFO IN THE TABLE VIA THE ABOVE LINK.<br />
** The onboard IOR start time (equivalent to the STP start time).<br />
* Log into [[SOOP KITCHEN]] and check whether there is an "analysis window" in the current STP. If there is an analysis window, we must include data requests as part of the IOR.<br />
** The start time, duration and end time of the STP/IOR can also be confirmed via [[SOOP KITCHEN]].<br />
* Download necessary input files. See nested bullets below. All can be found at https://pub023.cs.technik.fhnw.ch/gfts/solsoc/from_soc/ (This page is password protected. Contact Hualin at hualin.xiao@fhnw.ch to get access):<br />
** MIB:<br />
*** Check the current version number on [https://issues.cosmos.esa.int/solarorbiterwiki/display/SOSP/MIB+and+FOP Solar Orbiter wiki]. It is given by the "MIB Name" column.<br />
*** Ctrl+F the version number on the above pub023 web address and download.<br />
*** Unzip the file.<br />
** TMC:<br />
*** Provides constraints on data volume.<br />
*** Filename prefixed by TMC_ and suffixed by .xml.<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The TMC file for the correct LTP must be used otherwise Startlet will throw an error.<br />
*** There is one TMC per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Currently, although this file is required, STIX-Starlet does not extract information from this file. So we must check manually that the telemetry used by the IOR is within the telemetry allowance of the TMC file. Check this in SOOP Kitchen.<br />
** E-FECS<br />
*** Provides constraints on EMC<br />
*** Filename prefixed with EFECS_ and suffixed with .xml<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The EFECS file for the correct LTP must be used otherwise Startlet will throw an error.<br />
*** There is one EFECS per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Currently, STIX-Starlet does not extract information from this file. So we must check manually whether STIX must be in quiet mode any time during this IOR, i.e. must not use the motors. Check this in SOOP Kitchen.<br />
** JSON<br />
*** The JSON file contains certain info on the STP, e.g. the start and end time.<br />
*** The filename will also contains "MXX" where XX is the number of the LTP. The json file for the correct LTP must be used otherwise Startlet will not process the IOR correctly.<br />
*** There is one json per LTP, but the version is often updated by ESA. So always get the latest version for the relevant LTP from pub023 address above.<br />
*** Download latest version from the above pub023 URL. (The version here is usually the latest.)<br />
* Open [[STIX-Starlet]] and enter IOR metadata.<br />
** Set directory where IOR will be generated. Settings -> Set storage directory<br />
** Set Starlet to STIX format. Settings -> Instrument -> STIX<br />
** Enter the STP number from STP schedule into STP cycle field<br />
** Add your name in author field.<br />
** Add onboard start time from the STP schedule in the start time field.<br />
** End time must be before next STP starts and after all telecommands have been executed. A typical value would be 24 hours after the IOR start time.<br />
** If this is the first IOR for the current STP, set the file and version numbers to 1.<br />
*** If an IOR has to be recreated due to an issue found in review, iterate version number.<br />
*** If more the STP requires more than one distinct IOR, iterate the file number<br />
* Enter the paths of the required files:<br />
** MiB: Settings -> Set instrument Database. Then select the unzipped MIB directory.<br />
** E-FECS & TMC: Click folder icon on the right of the value fields and select the relevant files.<br />
** JSON: Do the same as for E-FECS and TMC. DO NOT click "Load JSON" at this stage.<br />
* Add telecommands via the "Add Sequence".<br />
** STIX commands are prefixed at "AIX". Enter this is in the search field at the top to filter out non-STIX sequences.<br />
** See [[IOR Tips and Tricks]] for more advice.<br />
** In particular, see [[IOR Tips and Tricks#Time of First Telecommand|Time of First Telecommand]] for when to start the first telecommand of the IOR.<br />
** To include data requests in the IOR, see the section below on [[#Including a Data Request in an IOR|Including a Data Request in an IOR]]<br />
* Once all sequences are added, click "Load JSON" button. This will assign OBS ID to all telecommands. These should all be the same for a given STP.<br />
* Generate IOR by clicking "Generate" button. This will create a .SOL file in the "storage directory" set above.<br />
<br />
== Test IOR on Ground Unit ==<br />
* If you still have the IOR open in STIX-Starlet, save the IOR to as a <code>.tcl</code> by clicking the <code>.tcl</code> button in the toolbar.<br />
<br />
See [[Using the STIX Ground Unit#Testing an IOR with the Ground Unit|Testing an IOR with the Ground Unit]].<br />
<br />
== Submit IOR for Internal Review ==<br />
* Upload IOR .SOL file by clicking the "Upload IOR" button at https://pub023.cs.technik.fhnw.ch/view/operations<br />
* Email the link to the IOR overview to the STIX ops team.<br />
** The IOR overview URL can be found by locating the IOR at the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] and clicking the green button in the "Overview" column.<br />
<br />
== Submit IOR to SOC ==<br />
Once the STIX team is happy with the IOR, submit it to the SOC by doing the following:<br />
* Generate and download an IORG zip file corresponding to the IOR to be submitted.<br />
** Find the ID of the IOR from the [https://pub023.cs.technik.fhnw.ch/view/ior/list Operation Requests List] on the STIX server.<br />
** Go to https://pub023.cs.technik.fhnw.ch/view/operations and click the button marked "Create IORG File".<br />
** Enter the ID of the first IOR into the start field and the ID of the last IOR to be included in the end field. Also enter the STP number and the IOR number (in most cases this is 1). Then click "Create and Download".<br />
* Send the IORG file to the SOC<br />
** You will need a server account write permissions. To get an account email Hualin at hualin.xiao@fhnw.ch or Dan Ryan at daniel.ryan@fhnw.ch<br />
** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Copy the IORG zip file to [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by opening a terminal and <code>cd</code> to the directory where you saved the IORG file above. Then type <code>sudo scp <IORG filename> <username>@147.86.8.26:~</code> where <code><IORG filename></code> is the name of the IORG file and <code><username></code> is the username of your account on the STIX GFTS server.<br />
** Login into the [https://issues.cosmos.esa.int/solarorbiterwiki/pages/viewpage.action?pageId=41949048 ESA's STIX GFTS server] by typing <code>ssh <username>@147.86.8.26</code><br />
*** If you are not on the FHNW network, you will have to [[Connect to the FHNW VPN]].<br />
** Change permissions on the IORG file: <code>sudo chmod 777 <IORG filename></code><br />
** Move the IORG file from the home directory (where we copied it to above) to the <code>to_soc</code> directory by typing <code>sudo cp ~/<IORG filename> /home/solsoc/to_soc/</code><br />
* Confirm the SOC has validated the IOR<br />
** The SOC will copy the file from the <code>to_soc</code> and then delete it. This can happen straight away. The SOC will then run an automatically verify the IOR and then return a <code>.CRR</code> back to the <code>/home/solsoc/from_soc</code> directory within 10 minutes.<br />
** <code>cd</code> to the <code>home/solsoc/from_soc</code> and wait for the <code>.CRR</code> to appear. It will have the same filename as the submitted IORG file, but with a <code>.CRR</code> extension.<br />
** Once the file has arrived, log out of the server.<br />
** Copy the <code>.CRR</code> file to your local machine by typing: <code>scp <username>@147.86.8.26:/home/solsoc/from_soc/<IORG filename> /local/folder/</code> where <code>/local/folder/</code> is the location on your local machine where the file should be copied.<br />
** Unzip the <code>.CRR</code> and open it with a text editor.<br />
** Search for the <validity> tag and confirm the message says "Valid".<br />
*** If the .CRR file reports "Valid", then we are done!<br />
*** If it is not valid, more details of the errors will be listed. Create a new version of the IOR (remembering to iterate the version number) that fixes those errors and resubmit.<br />
<br />
== Including a Data Request in an IOR ==<br />
See [[How to Create a Data Request IOR]]</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=STIX_Documentation&diff=16414STIX Documentation2024-05-02T08:58:16Z<p>Hualin: </p>
<hr />
<div>=== Instrumentation ===<br />
<br />
Details about the STIX instrumentation can be found in the following paper: <br />
<br />
*Säm Krucker, G. J. Hurford, et al., The Spectrometer/Telescope for Imaging X-rays (STIX), A&A, 642 (2020), DOI: https://doi.org/10.1051/0004-6361/201937362 <br><br />
<br />
=== STIX data center ===<br />
An brief introduction to STIX data center: https://datacenter.stix.i4ds.net/introduction/#h.2ba6b5e5907f600e_60 <br><br />
Details about the STIX data center can be found in the paper below: <br />
* Hualin Xiao, et al., The data center for the Spectrometer and Telescope for Imaging X-rays (STIX) on board Solar Orbiter, 2023, A&A, 673, A142, DOI: https://doi.org/10.1051/0004-6361/202346031<br />
<br />
=== STIX data analysis tutorials ===<br />
<br />
STIX tutorials are available at [https://datacenter.stix.i4ds.net/wiki/index.php?title=STIX_Tutorials].<br />
<br />
=== Interacting STIX Data Center using python ===<br />
<br />
<br />
Stixdcpy is a Python package that facilitates access and analysis of STIX data. It provides APIs to query and download data from the STIX data center and a set of tools for visualizing data and performing common analysis tasks. With stixdcpy, users can query and download the following types of data from the STIX data center:<br />
<br />
* Quick-look light curves<br />
* Housekeeping data<br />
* Science data<br />
* Energy calibration data<br />
* Auxiliary data<br />
* STIX solar flare list<br />
* STIX operational events"<br />
stixdcpy source code and the tutorial can be found at: https://github.com/i4ds/stixdcpy<br />
<br />
=== Cite Our Work ===<br />
see https://datacenter.stix.i4ds.net/wiki/index.php?title=Cite_our_work</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=STIX_Energy_Lookup_Table&diff=16387STIX Energy Lookup Table2024-04-15T13:52:16Z<p>Hualin: </p>
<hr />
<div>STIX instrument ELUTs and skylut can also be found at the following links:<br />
* releases:<br />
https://datacenter.stix.i4ds.net/pub/misc/stix-config/<br />
* github repo: <br />
https://github.com/i4Ds/STIX-CONF</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=STIX_Energy_Lookup_Table&diff=16386STIX Energy Lookup Table2024-04-15T13:52:09Z<p>Hualin: </p>
<hr />
<div>STIX instrument ELUTs and skylut can also be found at the following links:<br />
* releases:<br />
- https://datacenter.stix.i4ds.net/pub/misc/stix-config/<br />
* github repo: <br />
https://github.com/i4Ds/STIX-CONF</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=STIX_Energy_Lookup_Table&diff=16385STIX Energy Lookup Table2024-04-15T13:52:03Z<p>Hualin: </p>
<hr />
<div>STIX instrument ELUTs and skylut can also be found at the following link:<br />
* releases:<br />
- https://datacenter.stix.i4ds.net/pub/misc/stix-config/<br />
* github repo: <br />
https://github.com/i4Ds/STIX-CONF</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=STIX_Energy_Lookup_Table&diff=16384STIX Energy Lookup Table2024-04-15T13:51:53Z<p>Hualin: </p>
<hr />
<div>STIX instrument ELUTs and skylut can also be found at the following link:<br />
# releases:<br />
- https://datacenter.stix.i4ds.net/pub/misc/stix-config/<br />
# github repo: <br />
https://github.com/i4Ds/STIX-CONF</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=STIX_Energy_Lookup_Table&diff=16383STIX Energy Lookup Table2024-04-15T13:51:42Z<p>Hualin: </p>
<hr />
<div>STIX instrument ELUTs and skylut can also be found at the following link:<br />
releases:<br />
- https://datacenter.stix.i4ds.net/pub/misc/stix-config/<br />
github repo: <br />
https://github.com/i4Ds/STIX-CONF</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=Cite_our_work&diff=16380Cite our work2024-04-08T14:51:19Z<p>Hualin: </p>
<hr />
<div><br />
<h3>If your research has been significantly enhanced by STIX data products or the utilization of our tools, we kindly suggest referencing the following papers: </h3> <br><br />
<br />
<b>For users of STIX data products or our software, we request citation of the following two papers: </b><br><br />
[1] Säm Krucker, G. J. Hurford, et al., The Spectrometer/Telescope for Imaging X-rays (STIX), A&A, volume 642 (2020),<br><br />
DOI: https://doi.org/10.1051/0004-6361/201937362 <br><br />
[2] Hualin Xiao, Shane Maloney, Säm Krucker, et al.,The data center for the Spectrometer and Telescope for Imaging X-rays (STIX) on board Solar Orbiter, A&A in 2023, volume 673, A142, <br><br />
DOI: https://doi.org/10.1051/0004-6361/202346031 <br><br />
<br><br />
<br />
<b>For those employing STIX imaging principles and algorithms, please consider citing the following references: </b><br><br />
[3] MEM_GE: https://iopscience.iop.org/article/10.3847/1538-4357/ab8637<br><br />
[4] EM: https://www.aanda.org/articles/aa/full_html/2019/04/aa35323-19/aa35323-19.html<br><br />
[5] VIS_FWDFIT_PSO: https://www.aanda.org/articles/aa/pdf/2022/12/aa43907-22.pdf<br></div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=Cite_our_work&diff=16379Cite our work2024-04-08T14:51:03Z<p>Hualin: </p>
<hr />
<div><br />
<h3>If your research has been significantly enhanced by STIX data products or the utilization of our tools, we kindly suggest referencing the following papers: </h3> <br><br />
<br />
<b>For users of STIX data products or our software, we request citation of the following two papers: </b><br><br />
[1] Säm Krucker, G. J. Hurford, et al., The Spectrometer/Telescope for Imaging X-rays (STIX), A&A, volume 642 (2020),<br><br />
DOI: https://doi.org/10.1051/0004-6361/201937362 <br><br />
[2] Hualin Xiao, Shane Maloney, Säm Krucker, et al.,The data center for the Spectrometer and Telescope for Imaging X-rays (STIX) on board Solar Orbiter, A&A in 2023, volume 673, A142, <br><br />
DOI: https://doi.org/10.1051/0004-6361/202346031 <br><br />
<br />
<b>For those employing STIX imaging principles and algorithms, please consider citing the following references: </b><br><br />
[3] MEM_GE: https://iopscience.iop.org/article/10.3847/1538-4357/ab8637<br><br />
[4] EM: https://www.aanda.org/articles/aa/full_html/2019/04/aa35323-19/aa35323-19.html<br><br />
[5] VIS_FWDFIT_PSO: https://www.aanda.org/articles/aa/pdf/2022/12/aa43907-22.pdf<br></div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=Cite_our_work&diff=16378Cite our work2024-04-08T14:50:00Z<p>Hualin: </p>
<hr />
<div><br />
<h3>If your research has been significantly enhanced by STIX data products or the utilization of our tools, we kindly suggest referencing the following papers: </h3> <br><br />
<br />
<b>For users of STIX data products or our software, we request citation of the following two papers: </b><br><br />
[1] Säm Krucker, G. J. Hurford, et al., titled "The Spectrometer/Telescope for Imaging X-rays (STIX)" published in A&A, volume 642 (2020),<br><br />
DOI: https://doi.org/10.1051/0004-6361/201937362 <br><br />
[2] Hualin Xiao, Shane Maloney, Säm Krucker, Ewan Dickson, Paolo Massa, et al., titled "The data center for the Spectrometer and Telescope for Imaging X-rays (STIX) on board Solar Orbiter,"<br />
<br> published in A&A in 2023, volume 673, A142, <br><br />
DOI: https://doi.org/10.1051/0004-6361/202346031 <br><br />
<br />
<b>For those employing STIX imaging principles and algorithms, please consider citing the following references: </b><br><br />
[3] MEM_GE: https://iopscience.iop.org/article/10.3847/1538-4357/ab8637<br><br />
[4] EM: https://www.aanda.org/articles/aa/full_html/2019/04/aa35323-19/aa35323-19.html<br><br />
[5] VIS_FWDFIT_PSO: https://www.aanda.org/articles/aa/pdf/2022/12/aa43907-22.pdf<br></div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=Cite_our_work&diff=16377Cite our work2024-04-08T14:49:48Z<p>Hualin: </p>
<hr />
<div><br />
<h3>If your research has been significantly enhanced by STIX data products or the utilization of our tools, we kindly suggest referencing the following papers: </h3> <br><br />
<br />
<b>For users of STIX data products or our software, we request citation of the following two papers </b><br>:<br />
[1] Säm Krucker, G. J. Hurford, et al., titled "The Spectrometer/Telescope for Imaging X-rays (STIX)" published in A&A, volume 642 (2020),<br><br />
DOI: https://doi.org/10.1051/0004-6361/201937362 <br><br />
[2] Hualin Xiao, Shane Maloney, Säm Krucker, Ewan Dickson, Paolo Massa, et al., titled "The data center for the Spectrometer and Telescope for Imaging X-rays (STIX) on board Solar Orbiter,"<br />
<br> published in A&A in 2023, volume 673, A142, <br><br />
DOI: https://doi.org/10.1051/0004-6361/202346031 <br><br />
<br />
<b>For those employing STIX imaging principles and algorithms, please consider citing the following references: </b><br><br />
[3] MEM_GE: https://iopscience.iop.org/article/10.3847/1538-4357/ab8637<br><br />
[4] EM: https://www.aanda.org/articles/aa/full_html/2019/04/aa35323-19/aa35323-19.html<br><br />
[5] VIS_FWDFIT_PSO: https://www.aanda.org/articles/aa/pdf/2022/12/aa43907-22.pdf<br></div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=Cite_our_work&diff=16376Cite our work2024-04-08T14:49:26Z<p>Hualin: </p>
<hr />
<div><br />
<h2>If your research has been significantly enhanced by STIX data products or the utilization of our tools, we kindly suggest referencing the following papers: </h3> <br><br />
<br />
<b>For users of STIX data products or our software, we request citation of the following two papers </b><br>:<br />
[1] Säm Krucker, G. J. Hurford, et al., titled "The Spectrometer/Telescope for Imaging X-rays (STIX)" published in A&A, volume 642 (2020),<br><br />
DOI: https://doi.org/10.1051/0004-6361/201937362 <br><br />
[2] Hualin Xiao, Shane Maloney, Säm Krucker, Ewan Dickson, Paolo Massa, et al., titled "The data center for the Spectrometer and Telescope for Imaging X-rays (STIX) on board Solar Orbiter,"<br />
<br> published in A&A in 2023, volume 673, A142, <br><br />
DOI: https://doi.org/10.1051/0004-6361/202346031 <br><br />
<br />
<b>For those employing STIX imaging principles and algorithms, please consider citing the following references: </b><br><br />
[3] MEM_GE: https://iopscience.iop.org/article/10.3847/1538-4357/ab8637<br><br />
[4] EM: https://www.aanda.org/articles/aa/full_html/2019/04/aa35323-19/aa35323-19.html<br><br />
[5] VIS_FWDFIT_PSO: https://www.aanda.org/articles/aa/pdf/2022/12/aa43907-22.pdf<br></div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=Cite_our_work&diff=16375Cite our work2024-04-08T14:48:56Z<p>Hualin: </p>
<hr />
<div><br />
<h3>If your research has been significantly enhanced by STIX data products or the utilization of our tools, we kindly suggest referencing the following papers: </h3> <br><br />
<br />
For users of STIX data products or our software, we request citation of the following two papers:<br />
[1] Säm Krucker, G. J. Hurford, et al., titled "The Spectrometer/Telescope for Imaging X-rays (STIX)" published in A&A, volume 642 (2020),<br><br />
DOI: https://doi.org/10.1051/0004-6361/201937362 <br><br />
[2] Hualin Xiao, Shane Maloney, Säm Krucker, Ewan Dickson, Paolo Massa, et al., titled "The data center for the Spectrometer and Telescope for Imaging X-rays (STIX) on board Solar Orbiter,"<br />
<br> published in A&A in 2023, volume 673, A142, <br><br />
DOI: https://doi.org/10.1051/0004-6361/202346031 <br><br />
<br />
For those employing STIX imaging principles and algorithms, please consider citing the following references: <br><br />
[3] MEM_GE: https://iopscience.iop.org/article/10.3847/1538-4357/ab8637<br><br />
[4] EM: https://www.aanda.org/articles/aa/full_html/2019/04/aa35323-19/aa35323-19.html<br><br />
[5] VIS_FWDFIT_PSO: https://www.aanda.org/articles/aa/pdf/2022/12/aa43907-22.pdf<br></div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=Cite_our_work&diff=16374Cite our work2024-04-08T14:48:41Z<p>Hualin: </p>
<hr />
<div><br />
If your research has been significantly enhanced by STIX data products or the utilization of our tools, we kindly suggest referencing the following papers: <br><br />
<br />
For users of STIX data products or our software, we request citation of the following two papers:<br />
[1] Säm Krucker, G. J. Hurford, et al., titled "The Spectrometer/Telescope for Imaging X-rays (STIX)" published in A&A, volume 642 (2020),<br><br />
DOI: https://doi.org/10.1051/0004-6361/201937362 <br><br />
[2] Hualin Xiao, Shane Maloney, Säm Krucker, Ewan Dickson, Paolo Massa, et al., titled "The data center for the Spectrometer and Telescope for Imaging X-rays (STIX) on board Solar Orbiter,"<br />
<br> published in A&A in 2023, volume 673, A142, <br><br />
DOI: https://doi.org/10.1051/0004-6361/202346031 <br><br />
<br />
For those employing STIX imaging principles and algorithms, please consider citing the following references: <br><br />
[3] MEM_GE: https://iopscience.iop.org/article/10.3847/1538-4357/ab8637<br><br />
[4] EM: https://www.aanda.org/articles/aa/full_html/2019/04/aa35323-19/aa35323-19.html<br><br />
[5] VIS_FWDFIT_PSO: https://www.aanda.org/articles/aa/pdf/2022/12/aa43907-22.pdf<br></div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=Cite_our_work&diff=16373Cite our work2024-04-08T14:46:08Z<p>Hualin: </p>
<hr />
<div> <h2>If you found the STIX data products or our software useful in your research, please consider citing the following papers:</h2><br />
<p>For users of STIX data products or our software:</p><br />
<ol><br />
<li><br />
<p>Säm Krucker, G. J. Hurford, et al., "The Spectrometer/Telescope for Imaging X-rays (STIX)," published in A&A, volume 642 (2020),</p><br />
<p>DOI: <a href="https://doi.org/10.1051/0004-6361/201937362">https://doi.org/10.1051/0004-6361/201937362</a></p><br />
</li><br />
<li><br />
<p>Hualin Xiao, Shane Maloney, Säm Krucker, Ewan Dickson, Paolo Massa, et al., "The data center for the Spectrometer and Telescope for Imaging X-rays (STIX) on board Solar Orbiter," published in A&A in 2023, volume 673, A142,</p><br />
<p>DOI: <a href="https://doi.org/10.1051/0004-6361/202346031">https://doi.org/10.1051/0004-6361/202346031</a></p><br />
</li><br />
</ol><br />
<p>For those using STIX imaging principles and algorithms, please consider citing the following references:</p><br />
<ul><br />
<li><a href="https://iopscience.iop.org/article/10.3847/1538-4357/ab8637">MEM_GE</a></li><br />
<li><a href="https://www.aanda.org/articles/aa/full_html/2019/04/aa35323-19/aa35323-19.html">EM</a></li><br />
<li><a href="https://www.aanda.org/articles/aa/pdf/2022/12/aa43907-22.pdf">VIS_FWDFIT_PSO</a></li><br />
</ul></div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=Cite_our_work&diff=16372Cite our work2024-04-08T14:44:55Z<p>Hualin: </p>
<hr />
<div>If you found the STIX data products or our software useful in your research, please consider citing the following papers:<br />
<br />
For users of STIX data products or our software:<br />
#[https://doi.org/10.1051/0004-6361/201937362 Säm Krucker, G. J. Hurford, et al., <br> ''The Spectrometer/Telescope for Imaging X-rays (STIX)''], published in ''[[Astronomy & Astrophysics]]'', volume 642 (2020).<br />
#[https://doi.org/10.1051/0004-6361/202346031 Hualin Xiao, Shane Maloney, Säm Krucker, Ewan Dickson, Paolo Massa, et al., <br> ''The data center for the Spectrometer and Telescope for Imaging X-rays (STIX) on board Solar Orbiter''], published in ''[[Astronomy & Astrophysics]]'' in 2023, volume 673, A142.<br />
<br />
For those using STIX imaging principles and algorithms, please consider citing the following references:<br />
#[https://iopscience.iop.org/article/10.3847/1538-4357/ab8637 MEM_GE]<br />
#[https://www.aanda.org/articles/aa/full_html/2019/04/aa35323-19/aa35323-19.html EM]<br />
#[https://www.aanda.org/articles/aa/pdf/2022/12/aa43907-22.pdf VIS_FWDFIT_PSO]</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=Cite_our_work&diff=16371Cite our work2024-04-08T14:44:42Z<p>Hualin: </p>
<hr />
<div>If you found the STIX data products or our software useful in your research, please consider citing the following papers:<br />
<br />
For users of STIX data products or our software:<br />
#[https://doi.org/10.1051/0004-6361/201937362 Säm Krucker, G. J. Hurford, et al., ''The Spectrometer/Telescope for Imaging X-rays (STIX)''], published in ''[[Astronomy & Astrophysics]]'', volume 642 (2020).<br />
#[https://doi.org/10.1051/0004-6361/202346031 Hualin Xiao, Shane Maloney, Säm Krucker, Ewan Dickson, Paolo Massa, et al., <br> ''The data center for the Spectrometer and Telescope for Imaging X-rays (STIX) on board Solar Orbiter''], published in ''[[Astronomy & Astrophysics]]'' in 2023, volume 673, A142.<br />
<br />
For those using STIX imaging principles and algorithms, please consider citing the following references:<br />
#[https://iopscience.iop.org/article/10.3847/1538-4357/ab8637 MEM_GE]<br />
#[https://www.aanda.org/articles/aa/full_html/2019/04/aa35323-19/aa35323-19.html EM]<br />
#[https://www.aanda.org/articles/aa/pdf/2022/12/aa43907-22.pdf VIS_FWDFIT_PSO]</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=Cite_our_work&diff=16370Cite our work2024-04-08T14:44:22Z<p>Hualin: </p>
<hr />
<div>If you found the STIX data products or our software useful in your research, please consider citing the following papers:<br />
<br />
For users of STIX data products or our software:<br />
#[https://doi.org/10.1051/0004-6361/201937362 Säm Krucker, G. J. Hurford, et al., ''The Spectrometer/Telescope for Imaging X-rays (STIX)''], published in ''[[Astronomy & Astrophysics]]'', volume 642 (2020).<br />
#[https://doi.org/10.1051/0004-6361/202346031 Hualin Xiao, Shane Maloney, Säm Krucker, Ewan Dickson, Paolo Massa, et al., ''The data center for the Spectrometer and Telescope for Imaging X-rays (STIX) on board Solar Orbiter''], published in ''[[Astronomy & Astrophysics]]'' in 2023, volume 673, A142.<br />
<br />
For those using STIX imaging principles and algorithms, please consider citing the following references:<br />
#[https://iopscience.iop.org/article/10.3847/1538-4357/ab8637 MEM_GE]<br />
#[https://www.aanda.org/articles/aa/full_html/2019/04/aa35323-19/aa35323-19.html EM]<br />
#[https://www.aanda.org/articles/aa/pdf/2022/12/aa43907-22.pdf VIS_FWDFIT_PSO]</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=Cite_our_work&diff=16369Cite our work2024-04-08T14:43:09Z<p>Hualin: </p>
<hr />
<div>If your research has been significantly enhanced by STIX data products or the utilization of our tools, we kindly suggest referencing the following papers:<br />
<br />
For users of STIX data products or our software, we request citation of the following two papers:<br />
[1] Säm Krucker, G. J. Hurford, et al., titled "The Spectrometer/Telescope for Imaging X-rays (STIX)" published in A&A, volume 642 (2020),<br />
DOI: https://doi.org/10.1051/0004-6361/201937362<br />
[2] Hualin Xiao, Shane Maloney, Säm Krucker, Ewan Dickson, Paolo Massa, et al., titled "The data center for the Spectrometer and Telescope for Imaging X-rays (STIX) on board Solar Orbiter," published in A&A in 2023, volume 673, A142,<br />
DOI: https://doi.org/10.1051/0004-6361/202346031<br />
<br />
For those employing STIX imaging principles and algorithms, please consider citing the following references:<br />
[3] MEM_GE: https://iopscience.iop.org/article/10.3847/1538-4357/ab8637<br />
[4] EM: https://www.aanda.org/articles/aa/full_html/2019/04/aa35323-19/aa35323-19.html<br />
[5] VIS_FWDFIT_PSO: https://www.aanda.org/articles/aa/pdf/2022/12/aa43907-22.pdf</div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=Cite_our_work&diff=16368Cite our work2024-04-08T14:42:18Z<p>Hualin: </p>
<hr />
<div>If your research has greatly benefited from STIX data products or the utilization of our tools, we recommend citing our following papers:<br />
<br />
<ol><br />
<li> <b>If you used STIX data products or our software, please cite the following two papers :</b><br><br />
[1] Säm Krucker, G. J. Hurford, et al., The Spectrometer/Telescope for Imaging X-rays (STIX), A&A, 642 (2020),<br>DOI: https://doi.org/10.1051/0004-6361/201937362 <br><br />
[2] Hualin Xiao, Shane Maloney, Säm Krucker, Ewan Dickson, Paolo Massa, et al., The data center for the Spectrometer and Telescope for Imaging X-rays (STIX) on board Solar Orbiter, 2023, A&A, 673, A142,<br />
<br><br />
DOI: https://doi.org/10.1051/0004-6361/202346031 <br><br />
</li><br />
<br />
<br />
<li> <b>STIX imaging principles if you used the following imaging algorithms:</b><br><br />
<br />
[3] MEM_GE: https://iopscience.iop.org/article/10.3847/1538-4357/ab8637 <br><br />
[4] EM: https://www.aanda.org/articles/aa/full_html/2019/04/aa35323-19/aa35323-19.html <br><br />
[5] VIS_FWDFIT_PSO: https://www.aanda.org/articles/aa/pdf/2022/12/aa43907-22.pdf <br><br />
<br />
<br />
</li><br />
</ol></div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=Cite_our_work&diff=16367Cite our work2024-04-08T14:41:57Z<p>Hualin: </p>
<hr />
<div>If your research has greatly benefited from STIX data products or the utilization of our tools, we recommend citing our following papers:<br />
<br />
<ol><br />
<li> <b>If you used STIX data products or our software :</b><br><br />
[1] Säm Krucker, G. J. Hurford, et al., The Spectrometer/Telescope for Imaging X-rays (STIX), A&A, 642 (2020),<br>DOI: https://doi.org/10.1051/0004-6361/201937362 <br><br />
[2] Hualin Xiao, Shane Maloney, Säm Krucker, Ewan Dickson, Paolo Massa, et al., The data center for the Spectrometer and Telescope for Imaging X-rays (STIX) on board Solar Orbiter, 2023, A&A, 673, A142,<br />
<br><br />
DOI: https://doi.org/10.1051/0004-6361/202346031 <br><br />
</li><br />
<br />
<br />
<li> <b>STIX imaging principles if you used the following imaging algorithms:</b><br><br />
<br />
[3] MEM_GE: https://iopscience.iop.org/article/10.3847/1538-4357/ab8637 <br><br />
[4] EM: https://www.aanda.org/articles/aa/full_html/2019/04/aa35323-19/aa35323-19.html <br><br />
[5] VIS_FWDFIT_PSO: https://www.aanda.org/articles/aa/pdf/2022/12/aa43907-22.pdf <br><br />
<br />
<br />
</li><br />
</ol></div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=Cite_our_work&diff=16366Cite our work2024-04-08T14:41:33Z<p>Hualin: </p>
<hr />
<div>If your research has greatly benefited from STIX data products or the utilization of our tools, we recommend citing our following papers:<br />
<br />
<ol><br />
<li> <b>If you used STIX data products or our software :</b><br><br />
- Säm Krucker, G. J. Hurford, et al., The Spectrometer/Telescope for Imaging X-rays (STIX), A&A, 642 (2020),<br>DOI: https://doi.org/10.1051/0004-6361/201937362 <br><br />
- Hualin Xiao, Shane Maloney, Säm Krucker, Ewan Dickson, Paolo Massa, et al., The data center for the Spectrometer and Telescope for Imaging X-rays (STIX) on board Solar Orbiter, 2023, A&A, 673, A142,<br />
<br><br />
DOI: https://doi.org/10.1051/0004-6361/202346031 <br><br />
</li><br />
<br />
<br />
<li> <b>STIX imaging principles if you used the following imaging algorithms:</b><br><br />
<br />
MEM_GE: https://iopscience.iop.org/article/10.3847/1538-4357/ab8637 <br><br />
EM: https://www.aanda.org/articles/aa/full_html/2019/04/aa35323-19/aa35323-19.html <br><br />
VIS_FWDFIT_PSO: https://www.aanda.org/articles/aa/pdf/2022/12/aa43907-22.pdf <br><br />
<br />
<br />
</li><br />
</ol></div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=Cite_our_work&diff=16365Cite our work2024-04-08T14:39:27Z<p>Hualin: </p>
<hr />
<div>If your research has greatly benefited from STIX data products or the utilization of our tools, we recommend citing our following papers:<br />
<br />
<ol><br />
<li> <b>STIX data center paper if you used STIX data products or our tools:</b><br><br />
Hualin Xiao, Shane Maloney, Säm Krucker, Ewan Dickson, Paolo Massa, et al., The data center for the Spectrometer and Telescope for Imaging X-rays (STIX) on board Solar Orbiter, 2023, A&A, 673, A142,<br />
<br><br />
DOI: https://doi.org/10.1051/0004-6361/202346031 <br><br />
</li><br />
<br />
<li> <b>STIX instrument paper if you used STIX data products:</b><br><br />
Säm Krucker, G. J. Hurford, et al., The Spectrometer/Telescope for Imaging X-rays (STIX), A&A, 642 (2020),<br>DOI: https://doi.org/10.1051/0004-6361/201937362 <br><br />
<br />
</li><br />
<li> <b>STIX imaging principles if you used the following imaging algorithms:</b><br><br />
<br />
MEM_GE: https://iopscience.iop.org/article/10.3847/1538-4357/ab8637 <br><br />
EM: https://www.aanda.org/articles/aa/full_html/2019/04/aa35323-19/aa35323-19.html <br><br />
VIS_FWDFIT_PSO: https://www.aanda.org/articles/aa/pdf/2022/12/aa43907-22.pdf <br><br />
<br />
<br />
</li><br />
</ol></div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=Cite_our_work&diff=16316Cite our work2024-02-27T09:21:07Z<p>Hualin: </p>
<hr />
<div>If your research has greatly benefited from STIX data products or the utilization of our tools, we recommend citing our following papers:<br />
<br />
<ol><li> <b>STIX instrument paper:</b><br><br />
Säm Krucker, G. J. Hurford, et al., The Spectrometer/Telescope for Imaging X-rays (STIX), A&A, 642 (2020),<br>DOI: https://doi.org/10.1051/0004-6361/201937362 <br><br />
<br />
</li><br />
<li> <b>STIX data center paper if you used STIX data products or tools:</b><br><br />
Hualin Xiao, Shane Maloney, Säm Krucker, Ewan Dickson, Paolo Massa, et al., The data center for the Spectrometer and Telescope for Imaging X-rays (STIX) on board Solar Orbiter, 2023, A&A, 673, A142,<br />
<br><br />
DOI: https://doi.org/10.1051/0004-6361/202346031 <br><br />
</li><br />
<li> <b>STIX imaging principles if you used the following imaging algorithms:</b><br><br />
<br />
MEM_GE: https://iopscience.iop.org/article/10.3847/1538-4357/ab8637 <br><br />
EM: https://www.aanda.org/articles/aa/full_html/2019/04/aa35323-19/aa35323-19.html <br><br />
VIS_FWDFIT_PSO: https://www.aanda.org/articles/aa/pdf/2022/12/aa43907-22.pdf <br><br />
<br />
<br />
</li><br />
</ol></div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=Cite_our_work&diff=16315Cite our work2024-02-27T09:20:56Z<p>Hualin: </p>
<hr />
<div>If your research has greatly benefited from STIX data products or the utilization of our tools, we recommend citing our following papers:<br />
<br />
<ol><li> <b>STIX instrument paper:</b><br><br />
Säm Krucker, G. J. Hurford, et al., The Spectrometer/Telescope for Imaging X-rays (STIX), A&A, 642 (2020),<br>DOI: https://doi.org/10.1051/0004-6361/201937362 <br><br />
<br />
</li><br />
<li> <b>STIX data center paper if you used STIX data products or tools:</b><br><br />
Hualin Xiao, Shane Maloney, Säm Krucker, Ewan Dickson, Paolo Massa, et al., The data center for the Spectrometer and Telescope for Imaging X-rays (STIX) on board Solar Orbiter, 2023, A&A, 673, A142,<br />
<br><br />
DOI: https://doi.org/10.1051/0004-6361/202346031 <br><br />
</li><br />
<li> <b>STIX imaging principles if you used the following imaging algorithms</b><br><br />
<br />
MEM_GE: https://iopscience.iop.org/article/10.3847/1538-4357/ab8637 <br><br />
EM: https://www.aanda.org/articles/aa/full_html/2019/04/aa35323-19/aa35323-19.html <br><br />
VIS_FWDFIT_PSO: https://www.aanda.org/articles/aa/pdf/2022/12/aa43907-22.pdf <br><br />
<br />
<br />
</li><br />
</ol></div>Hualinhttps://pub023.cs.technik.fhnw.ch/wiki/index.php?title=STIX_Data_Center_Figures:_STIX_Quick-look_data_browser&diff=16288STIX Data Center Figures: STIX Quick-look data browser2023-08-15T13:27:07Z<p>Hualin: </p>
<hr />
<div>[[Category:STIX Data Center Figures]]<br />
= STIX Quick-look data browser =<br />
This page allows plotting STIX quick-look data and displaying simultaneous observations of external instruments. <br />
== <span id="STIX%20Quick-look%20Light%20Curves"></span> STIX Quick-look Light Curves ==<br />
<br />
[[File:Stix ql lc panel.png|750px|none|left|STIX quick-look light curve panel]]<br />
<br />
STIX quick-look light curves represent time series of counts summed by the detector in five energy bands, with a default integration time of 4 seconds. <br> The counts have not been adjusted for dead time, transmission, attenuator effects, or rate control regimes. The quick-look light curve data from STIX is transmitted to the ground along with other low-latency data. <br><br />
Generally, these data are received by STIX data centers within a timeframe ranging from tens of minutes to two days after their generation on board.<br />
<br />
== Reproduce STIX quick-look plots on your computer ==<br />
<br />
Quick-look plots can be reproduced on your computer using [https://github.com/i4Ds/stixdcpy stixdcpy]</div>Hualin