Explain dataio yaml file format

cositools · Mar 24, 2024 · f08a526 · f08a526
1 parent 9e6093b
commit f08a526
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/docs/tutorials/DataIO/DataIO_example.ipynb b/docs/tutorials/DataIO/DataIO_example.ipynb
@@ -429,12 +429,12 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "A typical configuration yaml files looks like this:\n",
+    "A typical DataIO configuration yaml files looks like this:\n",
     "\n",
     "```yaml\n",
-    "data_file: \"/path/to/crab/tra/file # Full path to unbinned tra data file\" \n",
-    "ori_file: \"/path/to/ori/file\" # full path to spacecraft orientation file. See next tutorial.\n",
-    "unbinned_output: 'hdf5' # Format of converted unbinned file 'fits' or 'hdf5'\n",
+    "data_file: \"/path/to/crab/tra/file\" # Full path to unbinned tra data file. Only needed when converting a tra file to fits or HDF5.\n",
+    "ori_file: \"/path/to/ori/file\" # Full path to spacecraft orientation file. See next tutorial. Only needed when converting a tra file to fits or HDF5.\n",
+    "unbinned_output: 'hdf5' # Format of converted unbinned file 'fits' or 'hdf5'. Only needed when converting a tra file to fits or HDF5.\n",
     "time_bins: 60 # time bin size in seconds. Takes int, float, or list of bin edges.\n",
     "energy_bins: [100.,  200.,  500., 1000., 2000., 5000.] # Energy  bin edges [keV]. Needs to match response binning.\n",
     "phi_pix_size: 6 # binning of Compton scattering angle [deg]. \n",