Update Documentation and odfcontrol

documentation/Jupyter_Notebooks/xmm-epic-reprocessing.ipynb

@@ -41,8 +41,8 @@
    "id": "83fe6e1b-e823-4bfc-b99c-62ec4185511d",
    "metadata": {},
    "source": [
-    "##### Last Reviewed: _1 August 2024, for SAS v21_\n",
-    "##### Last Updated: _1 August 2024_\n",
+    "##### Last Reviewed: _1 May 2024, for SAS v21_\n",
+    "##### Last Updated: _1 May 2024_\n",
     "##### By: Ryan Tanner (ryan.tanner@nasa.gov)\n",
     "---"
    ]
@@ -481,7 +481,7 @@
     "\n",
     "    <tt>emproc withsrccoords=yes srcra=34.65646 srcdec=-12.876546</tt>\n",
     "\n",
-    "- If you want to filter the event list events, using an external Good Time Interval (GTI) file (see the Jupyter Notebook on <a href=\"./xmm_ABC_guide_images_and_filters.ipynb\">Images and Filters</a> from the ABC Guide on how to filter event files for flaring particle background by creating a GTI file):\n",
+    "- If you want to filter the event list events, using an external Good Time Interval (GTI) file (see the corresponding thread on how to filter event files for flaring particle background by creating a GTI file):\n",
     "\n",
     "    <tt>emproc withgtiset=yes gtiset=mygti.gti filterevents=yes</tt>"
    ]

documentation/Jupyter_Notebooks/xmm-pysas-intro-long.ipynb

@@ -22,7 +22,7 @@
     "\n",
     "#### Prerequisites\n",
     "<div class=\"alert alert-block alert-info\">\n",
-    "    <b>Note:</b> Before running this notebook, or even starting a Jupyter Lab session, HEASOFT has to be initialized. If you did not initalize HEASOFT before starting this Jupyter Lab session, or opening this notebook, please close this window and initalize HEASOFT (it is not possible to initalize HEASOFT from within a Jupyter Notebook). SAS defaults will need to be set as explained in the README on <a href=\"https://github.com/XMMGOF/pysas/blob/main/README.md\">GitHub</a>.\n",
+    "    <b>Note:</b> Before running this notebook, or even starting a Jupyter Lab session, HEASOFT has to be initialized. If you did not initalize HEASOFT before starting this Jupyter Lab session, or opening this notebook, please close this window and initalize HEASOFT (it is not possible to initalize HEASOFT from within a Jupyter Notebook). SAS defaults will need to be set as explained in the README on GitHub (https://github.com/XMMGOF/pysas/blob/main/README.md).\n",
     "</div>\n",
     "\n",
     "#### Useful Links\n",
@@ -35,7 +35,7 @@
     "- [XMM Newton GOF Helpdesk](https://heasarc.gsfc.nasa.gov/docs/xmm/xmm_helpdesk.html \"Helpdesk\") - Link to form to contact the GOF Helpdesk.\n",
     "\n",
     "#### Caveats\n",
-    "This tutorial uses an observation of NGC3079 (obsid = '0802710101')."
+    "This tutorial uses an observation of NGC3079 (obsid = '0802710101'). The following assumes this notebook is run from the <tt>(xmmsas)</tt> environment on SciServer. You should see <tt>(xmmsas)</tt> at the top right of the notebook. If not, click there and select <tt>(xmmsas)</tt>."
    ]
   },
   {
@@ -79,16 +79,15 @@
    "source": [
     "import os\n",
     "import pysas\n",
-    "obsid = '0802710101'\n",
-    "data_dir = './'"
+    "obsid = '0802710101'"
    ]
   },
   {
    "cell_type": "markdown",
    "id": "3ff6fc63-f00d-4041-b212-869ef6b5bd0b",
    "metadata": {},
    "source": [
-    "By running the cell below, an Observation Data File (ODF) object is created. By itself it doesn't do anything, but it has several helpful functions to get your data ready to analyse and it will contain links to important directories and files."
+    "By running the cell below, an Observation Data File (odf) object is created. By itself it doesn't do anything, but it has several helpful functions to get your data ready to analyse and it will contain links to important directories and files."
    ]
   },
   {
@@ -520,7 +519,7 @@
    "source": [
     "### Just the Raw Data\n",
     "\n",
-    "If you want to just copy the raw data, and not do anything with it, you can use the function `download_data`. The function takes `obsid` and `data_dir` (both required) and copies the data from the HEASARC servers. If the directory `data_dir` does not exist, it will create it. It will also create a subdirectory for the `obsid`. <code style=\"background:yellow;color:black\">WARNING:</code> This function will silently erase any prior data in the directory `$data_dir/obsid/`."
+    "If you want to just copy the raw data, and not do anything with it, you can use the function `download_data`. The function takes `obsid` and `data_dir` (both required) and copies the data from the HEASARC on SciServer. If the directory `data_dir` does not exist, it will create it. It will also create a subdirectory for the `obsid`. <code style=\"background:yellow;color:black\">WARNING:</code> This function will silently erase any prior data in the directory `$data_dir/obsid/`."
    ]
   },
   {
@@ -530,7 +529,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "pysas.odfcontrol.download_data(obsid,data_dir,repo='heasarc')"
+    "pysas.sasutils.download_data(obsid,data_dir,repo='heasarc')"
    ]
   }
  ],

documentation/Jupyter_Notebooks/xmm-pysas-intro-short.ipynb

@@ -28,7 +28,7 @@
    "id": "36e8ac89-bfa6-4e81-b9d5-57353b98dd45",
    "metadata": {},
    "source": [
-    "##### Last Reviewed: _29 July 2024, for SAS v21_\n",
+    "## Last Reviewed: _29 July 2024, for SAS v21_\n",
     "##### Last Updated: _29 July 2024_\n",
     "##### By: Ryan Tanner (ryan.tanner@nasa.gov)\n",
     "---"