Maria Benito / ctools

Commit 470cf287cf1b494e50d9b97dbaf3d2ed19dfa210

Authored by Jürgen Knödlseder
1 parent d2b9dbf6

Update 1DC documentation for data pre-release for Milano

Inline Side-by-side
Showing 5 changed files with 63 additions and 144 deletions
doc/source/users/tutorials/1dc/data_organisation.rst
  View file @470cf28
... ... @@ -6,7 +6,7 @@ Data organisation
6 6 Layout
7 7 ^^^^^^
8 8  
9   -The content of the ``1dc`` folder should be as follows:
  9 +The content of the ``1dc.pre`` folder should be as follows:
10 10  
11 11 .. code-block:: bash
12 12  
... ... @@ -18,41 +18,16 @@ The content of the ``1dc`` folder should be as follows:
18 18 caldb/data/cta/prod3b/bcf
19 19 ...
20 20 data/
21   - data/gc_baseline_000001.fits
22   - data/gc_baseline_000002.fits
  21 + data/baseline/
  22 + data/baseline/gc
  23 + data/baseline/gc/gc_baseline_000001.fits
  24 + data/baseline/gc/gc_baseline_000002.fits
23 25 ...
24   - data/gc_threshold_000001.fits
25   - data/gc_threshold_000002.fits
26   - ...
27   - data/
28   - data/gps_baseline_000001.fits
29   - data/gps_baseline_000002.fits
30   - ...
31   - data/gps_threshold_000001.fits
32   - data/gps_threshold_000002.fits
33   - ...
34   - data/egal_baseline_000001.fits
35   - data/egal_baseline_000002.fits
36   - ...
37   - data/egal_threshold_000001.fits
38   - data/egal_threshold_000002.fits
39   - ...
40   - data/obs_gc_baseline.xml
41   - data/obs_gc_threshold.xml
42   - data/obs_gps_baseline.xml
43   - data/obs_gps_threshold.xml
44   - data/obs_egal_baseline.xml
45   - data/obs_egal_threshold.xml
46   - data/obs_all_baseline.xml
47   - data/obs_all_threshold.xml
48 26 models/
49 27 models/models_gc.xml
50   - models/models_gps.xml
51   - models/models_egal.xml
52   - models/map_RXJ1713.fits.gz
53   - models/map_VelaJunior.fits.gz
54   - models/map_ics.fits.gz
55   - models/map_pi0.fits.gz
  28 + ...
  29 + obs/
  30 + obs/obs_gc_baseline.xml
56 31  
57 32  
58 33 Instrument Response Functions
... ... @@ -63,59 +38,25 @@ The ``caldb`` folder contains the
63 38 that are necessary for the analysis of the simulated CTA data.
64 39 The folder contains the ``prod3b`` response that should be used for the
65 40 :ref:`first CTA Data Challenge <glossary_1dc>`.
66   -The following response functions are available:
  41 +In the pre-release, only the response functions for CTA South are
  42 +available for a zenith angle of 20 deg.
  43 +Specifically, the following response functions are available:
67 44  
68 45 +-----------------------+-------+---------------+--------+----------+
69 46 | Response name | Site | Configuration | Zenith | Duration |
70 47 +=======================+=======+===============+========+==========+
71 48 | ``South_z20_50h`` | South | Baseline | 20 deg | 50 hours |
72 49 +-----------------------+-------+---------------+--------+----------+
73   - | ``South_z40_50h`` | South | Baseline | 40 deg | 50 hours |
74   - +-----------------------+-------+---------------+--------+----------+
75 50 | ``South_z20_5h`` | South | Baseline | 20 deg | 5 hours |
76 51 +-----------------------+-------+---------------+--------+----------+
77   - | ``South_z40_5h`` | South | Baseline | 40 deg | 5 hours |
78   - +-----------------------+-------+---------------+--------+----------+
79 52 | ``South_z20_0.5h`` | South | Baseline | 20 deg | 30 min |
80 53 +-----------------------+-------+---------------+--------+----------+
81   - | ``South_z40_0.5h`` | South | Baseline | 40 deg | 30 min |
82   - +-----------------------+-------+---------------+--------+----------+
83   - | ``North_z20_50h`` | North | Baseline | 20 deg | 50 hours |
84   - +-----------------------+-------+---------------+--------+----------+
85   - | ``North_z40_50h`` | North | Baseline | 40 deg | 50 hours |
86   - +-----------------------+-------+---------------+--------+----------+
87   - | ``North_z20_5h`` | North | Baseline | 20 deg | 5 hours |
88   - +-----------------------+-------+---------------+--------+----------+
89   - | ``North_z40_5h`` | North | Baseline | 40 deg | 5 hours |
90   - +-----------------------+-------+---------------+--------+----------+
91   - | ``North_z20_0.5h`` | North | Baseline | 20 deg | 30 min |
92   - +-----------------------+-------+---------------+--------+----------+
93   - | ``North_z40_0.5h`` | North | Baseline | 40 deg | 30 min |
94   - +-----------------------+-------+---------------+--------+----------+
95 54 | ``South_TS_z20_50h`` | South | Threshold | 20 deg | 50 hours |
96 55 +-----------------------+-------+---------------+--------+----------+
97   - | ``South_TS_z40_50h`` | South | Threshold | 40 deg | 50 hours |
98   - +-----------------------+-------+---------------+--------+----------+
99 56 | ``South_TS_z20_5h`` | South | Threshold | 20 deg | 5 hours |
100 57 +-----------------------+-------+---------------+--------+----------+
101   - | ``South_TS_z40_5h`` | South | Threshold | 40 deg | 5 hours |
102   - +-----------------------+-------+---------------+--------+----------+
103 58 | ``South_TS_z20_0.5h`` | South | Threshold | 20 deg | 30 min |
104 59 +-----------------------+-------+---------------+--------+----------+
105   - | ``South_TS_z40_0.5h`` | South | Threshold | 40 deg | 30 min |
106   - +-----------------------+-------+---------------+--------+----------+
107   - | ``North_TS_z20_50h`` | North | Threshold | 20 deg | 50 hours |
108   - +-----------------------+-------+---------------+--------+----------+
109   - | ``North_TS_z40_50h`` | North | Threshold | 40 deg | 50 hours |
110   - +-----------------------+-------+---------------+--------+----------+
111   - | ``North_TS_z20_5h`` | North | Threshold | 20 deg | 5 hours |
112   - +-----------------------+-------+---------------+--------+----------+
113   - | ``North_TS_z40_5h`` | North | Threshold | 40 deg | 5 hours |
114   - +-----------------------+-------+---------------+--------+----------+
115   - | ``North_TS_z20_0.5h`` | North | Threshold | 20 deg | 30 min |
116   - +-----------------------+-------+---------------+--------+----------+
117   - | ``North_TS_z40_0.5h`` | North | Threshold | 40 deg | 30 min |
118   - +-----------------------+-------+---------------+--------+----------+
119 60  
120 61 .. warning::
121 62 The **50 hours**
... ... @@ -163,12 +104,25 @@ the pointing direction in Right Ascension and Declination (see figure below).
163 104 *Header of an event list*
164 105  
165 106 .. note::
166   - The pointing direction during an observation is fixed.
  107 + The pointing direction during an observation is fixed. The simulation has
  108 + the following characteristics:
  109 +
  110 + * Number of observations (and pointings): 1673
  111 + * Duration of each observation: 1800 sec
  112 + * Deadtime fraction: 5%
  113 + * Total exposure time of simulation: 836.5 hours
  114 + * Simulated event energies: 30 GeV - 120 TeV
  115 + * Maximum off-axis angle: 5 deg
  116 + * Start data of observations: 1/1/2021
167 117  
168 118 .. warning::
169 119 Only the following header keywords in the ``EVENTS`` table have meaningful
170 120 values:
171 121  
  122 + * ``DSTYPx`` - Data sub-space type
  123 + * ``DSUNIx`` - Data sub-space unit
  124 + * ``DSVALx`` - Data sub-space value
  125 + * ``DSREFx`` - Data sub-space reference
172 126 * ``DATE_OBS`` - start date of observation (UTC)
173 127 * ``TIME_OBS`` - start time of observation (UTC)
174 128 * ``DATE_END`` - end date of observation (UTC)
... ... @@ -222,54 +176,15 @@ An example of an ``EVENTS`` table is shown below.
222 176  
223 177 *Content of an event list*
224 178  
225   -Event files exist for
226   -
227   - +-----------------+---------------+--------------------+------------------+
228   - | Survey | Configuration | Prefix | Energy range |
229   - +=================+===============+====================+==================+
230   - | Galactic Centre | Baseline | ``gc_baseline`` | |
231   - +-----------------+---------------+--------------------+------------------+
232   - | Galactic Plane | Baseline | ``gps_baseline`` | 30 GeV - 120 TeV |
233   - +-----------------+---------------+--------------------+------------------+
234   - | Extragalactic | Baseline | ``egal_baseline`` | |
235   - +-----------------+---------------+--------------------+------------------+
236   - | Galactic Centre | Threshold | ``gc_threshold`` | |
237   - +-----------------+---------------+--------------------+------------------+
238   - | Galactic Plane | Threshold | ``gps_threshold`` | |
239   - +-----------------+---------------+--------------------+------------------+
240   - | Extragalactic | Threshold | ``egal_threshold`` | |
241   - +-----------------+---------------+--------------------+------------------+
242   -
243 179  
244 180 Observation Definition Files
245 181 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
246 182  
247   -The files ``obs_XXX_YYYYY.xml`` are so called
248   -:ref:`Observation Definition Files <glossary_obsdef>`
249   -that contain the information (or metadata) of a list of observations.
250   -The files are plain ASCII files in XML format that can be inspected and
  183 +The file ``obs_gc_baseline.xml`` is a so called
  184 +:ref:`Observation Definition File <glossary_obsdef>`
  185 +that contains the information (or metadata) of a list of observations.
  186 +The file is a plain ASCII files in XML format that can be inspected and
251 187 manipulated by any text editor.
252   -The following files are included in the distribution:
253   -
254   - +----------------------------+--------------------------------------------------------+
255   - | File | Purpose |
256   - +============================+========================================================+
257   - | ``obs_gc_baseline.xml`` | Galactic Centre Survey performed with baseline arrays |
258   - +----------------------------+--------------------------------------------------------+
259   - | ``obs_gc_threshold.xml`` | Galactic Centre Survey performed with threshold arrays |
260   - +----------------------------+--------------------------------------------------------+
261   - | ``obs_gps_baseline.xml`` | Galactic Plane Survey performed with baseline arrays |
262   - +----------------------------+--------------------------------------------------------+
263   - | ``obs_gps_threshold.xml`` | Galactic Plane Survey performed with threshold arrays |
264   - +----------------------------+--------------------------------------------------------+
265   - | ``obs_egal_baseline.xml`` | Extragalactic Survey performed with baseline arrays |
266   - +----------------------------+--------------------------------------------------------+
267   - | ``obs_egal_threshold.xml`` | Extragalactic Survey performed with threshold arrays |
268   - +----------------------------+--------------------------------------------------------+
269   - | ``obs_all_baseline.xml`` | All surveys combined performed with baseline arrays |
270   - +----------------------------+--------------------------------------------------------+
271   - | ``obs_all_threshold.xml`` | All surveys combined performed with threshold arrays |
272   - +----------------------------+--------------------------------------------------------+
273 188  
274 189  
275 190 Models
... ... @@ -281,13 +196,11 @@ The file ``models_gc.xml`` is a so called
281 196 :ref:`Model Definition File <glossary_moddef>`
282 197 that collects the definition of all model components used for the Galactic
283 198 Centre Survey simulation.
284   -The files ``models_gps.xml`` and ``models_egal.xml`` are the equivalent files
285   -for the Galactic Plane Survey and the Extragalactic Survey.
286   -The other files in the folder are FITS files containing sky maps that were
287   -used as spatial templates for modelling extended or diffuse emission components.
  199 +The other files in the folder are ASCII and FITS files containing spectral,
  200 +temporal and spatial information that was used in the simulations.
288 201  
289 202 .. warning::
290   - The FITS template files should always reside in the same folder as the
  203 + The ASCII and FITS files should always reside in the same folder as the
291 204 :ref:`model definition XML files <glossary_moddef>`
292 205 since the latter reference the former.
293 206  
... ...
doc/source/users/tutorials/1dc/event_file.png
View file @470cf28

18.9 KB | W: | H:

36.1 KB | W: | H:

  • 2-up
  • Swipe
  • Onion skin
doc/source/users/tutorials/1dc/event_header.png
View file @470cf28

63.2 KB | W: | H:

85.2 KB | W: | H:

  • 2-up
  • Swipe
  • Onion skin
doc/source/users/tutorials/1dc/event_list.png
View file @470cf28

86.1 KB | W: | H:

83.4 KB | W: | H:

  • 2-up
  • Swipe
  • Onion skin
doc/source/users/tutorials/1dc/getting_data.rst
  View file @470cf28
... ... @@ -3,51 +3,57 @@
3 3 Getting the data
4 4 ================
5 5  
6   -The data for the
  6 +A pre-release of the data for the
7 7 :ref:`first CTA Data Challenge <glossary_1dc>`
8   -are available on the
  8 +is available on the
9 9 `CTA ownCloud server <https://owncloud.cta-observatory.org>`_.
10 10 You need your usual CTA credentials to download the data.
  11 +The full
  12 +:ref:`first CTA Data Challenge <glossary_1dc>`
  13 +data release is planned for the second half of March 2017.
11 14  
12   -The data have been split in number of tarballs that are summarised in
13   -the following table. You may click on the links in the second column
14   -to download the data.
  15 +The pre-release contains simulated data for the Galactic Centre Survey,
  16 +:ref:`Instrument Response Functions (IRFs) <glossary_irf>`, and the
  17 +:ref:`model definition files <glossary_moddef>`
  18 +that were used for the simulation.
  19 +The data were split into the separate files that can be downloaded
  20 +by clicking on the following links:
15 21  
16   - +-------------------------------+-------------------------------------------------------------------------------+
17   - | Content | Download link |
18   - +===============================+===============================================================================+
19   - | Instrument Response Functions | `<https://owncloud.cta-observatory.org/remote.php/webdav/1dc/caldb.tar.gz>`_ |
20   - +-------------------------------+-------------------------------------------------------------------------------+
21   - | Sky and background models | `<https://owncloud.cta-observatory.org/remote.php/webdav/1dc/models.tar.gz>`_ |
22   - +-------------------------------+-------------------------------------------------------------------------------+
  22 +* `Galactic Centre Survey <https://owncloud.cta-observatory.org/remote.php/webdav/1dc.pre/gc-pre.tar.gz>`_ (5.9 GB)
  23 +* `Instrument Response Functions <https://owncloud.cta-observatory.org/remote.php/webdav/1dc.pre/caldb-pre.tar.gz>`_ (0.2 MB)
  24 +* `Sky and background models <https://owncloud.cta-observatory.org/remote.php/webdav/1dc.pre/models-pre.tar.gz>`_ (0.9 GB)
23 25  
24   -You may also download the files using the ``wget`` tool from the command
25   -line by typing (``<user>`` needs to be replaced by your CTA user name):
  26 +You can also download the files using the ``wget`` tool from the command
  27 +line by typing:
26 28  
27 29 .. code-block:: bash
28 30  
29   - $ wget https://owncloud.cta-observatory.org/remote.php/webdav/1dc/caldb.tar.gz --user=<user> --ask-password
30   - $ wget https://owncloud.cta-observatory.org/remote.php/webdav/1dc/models.tar.gz --user=<user> --ask-password
  31 + $ wget https://owncloud.cta-observatory.org/remote.php/webdav/1dc.pre/gc-pre.tar.gz --user=<user> --ask-password
  32 + $ wget https://owncloud.cta-observatory.org/remote.php/webdav/1dc.pre/caldb-pre.tar.gz --user=<user> --ask-password
  33 + $ wget https://owncloud.cta-observatory.org/remote.php/webdav/1dc.pre/models-pre.tar.gz --user=<user> --ask-password
31 34  
32 35 .. warning::
33   - Don't type the ``$`` symbol. It indicates in the following that a command
34   - should be typed on the command line of a console.
  36 + ``<user>`` needs to be replaced by your CTA user name.
  37 + Don't type the ``$`` symbol. It indicates that a command should be typed
  38 + on the command line of a console.
35 39  
36 40 After downloading, uncompress the files at any place by typing
37 41  
38 42 .. code-block:: bash
39 43  
40   - $ tar xfvz caldb.tar.gz
41   - $ tar xfvz models.tar.gz
  44 + $ tar xfvz gc-pre.tar.gz
  45 + $ tar xfvz caldb-pre.tar.gz
  46 + $ tar xfvz models-pre.tar.gz
  47 +
  48 +You should now have a folder named ``1dc.pre`` in your current working
  49 +directory.
42 50  
43   -After that you should have the folder ``1dc`` in your current working
44   -directory. Type there the following to set the ``CALDB`` and ``CTADATA``
45   -environment variables:
  51 +Before continuing, please set the following environment variables:
46 52  
47 53 .. code-block:: bash
48 54  
49   - $ export CALDB=$PWD/1dc/caldb
50   - $ export CTADATA=$PWD/1dc/data
  55 + $ export CALDB=$PWD/1dc.pre/caldb
  56 + $ export CTADATA=$PWD/1dc.pre/data
51 57  
52 58 .. note::
53 59 You may consider adding the ``CALDB`` and ``CTADATA`` environment variables
... ...