From 470cf287cf1b494e50d9b97dbaf3d2ed19dfa210 Mon Sep 17 00:00:00 2001 From: Jürgen Knödlseder Date: Thu, 2 Mar 2017 20:49:42 +0100 Subject: [PATCH] Update 1DC documentation for data pre-release for Milano --- doc/source/users/tutorials/1dc/data_organisation.rst | 151 ++++++++++++++++++++++++++++++++----------------------------------------------------------------------------------------------------------------------- doc/source/users/tutorials/1dc/event_file.png | Bin 19318 -> 0 bytes doc/source/users/tutorials/1dc/event_header.png | Bin 64707 -> 0 bytes doc/source/users/tutorials/1dc/event_list.png | Bin 88142 -> 0 bytes doc/source/users/tutorials/1dc/getting_data.rst | 56 +++++++++++++++++++++++++++++++------------------------- 5 files changed, 63 insertions(+), 144 deletions(-) diff --git a/doc/source/users/tutorials/1dc/data_organisation.rst b/doc/source/users/tutorials/1dc/data_organisation.rst index 511b147..66a6e8a 100644 --- a/doc/source/users/tutorials/1dc/data_organisation.rst +++ b/doc/source/users/tutorials/1dc/data_organisation.rst @@ -6,7 +6,7 @@ Data organisation Layout ^^^^^^ -The content of the ``1dc`` folder should be as follows: +The content of the ``1dc.pre`` folder should be as follows: .. code-block:: bash @@ -18,41 +18,16 @@ The content of the ``1dc`` folder should be as follows: caldb/data/cta/prod3b/bcf ... data/ - data/gc_baseline_000001.fits - data/gc_baseline_000002.fits + data/baseline/ + data/baseline/gc + data/baseline/gc/gc_baseline_000001.fits + data/baseline/gc/gc_baseline_000002.fits ... - data/gc_threshold_000001.fits - data/gc_threshold_000002.fits - ... - data/ - data/gps_baseline_000001.fits - data/gps_baseline_000002.fits - ... - data/gps_threshold_000001.fits - data/gps_threshold_000002.fits - ... - data/egal_baseline_000001.fits - data/egal_baseline_000002.fits - ... - data/egal_threshold_000001.fits - data/egal_threshold_000002.fits - ... - data/obs_gc_baseline.xml - data/obs_gc_threshold.xml - data/obs_gps_baseline.xml - data/obs_gps_threshold.xml - data/obs_egal_baseline.xml - data/obs_egal_threshold.xml - data/obs_all_baseline.xml - data/obs_all_threshold.xml models/ models/models_gc.xml - models/models_gps.xml - models/models_egal.xml - models/map_RXJ1713.fits.gz - models/map_VelaJunior.fits.gz - models/map_ics.fits.gz - models/map_pi0.fits.gz + ... + obs/ + obs/obs_gc_baseline.xml Instrument Response Functions @@ -63,59 +38,25 @@ The ``caldb`` folder contains the that are necessary for the analysis of the simulated CTA data. The folder contains the ``prod3b`` response that should be used for the :ref:`first CTA Data Challenge `. -The following response functions are available: +In the pre-release, only the response functions for CTA South are +available for a zenith angle of 20 deg. +Specifically, the following response functions are available: +-----------------------+-------+---------------+--------+----------+ | Response name | Site | Configuration | Zenith | Duration | +=======================+=======+===============+========+==========+ | ``South_z20_50h`` | South | Baseline | 20 deg | 50 hours | +-----------------------+-------+---------------+--------+----------+ - | ``South_z40_50h`` | South | Baseline | 40 deg | 50 hours | - +-----------------------+-------+---------------+--------+----------+ | ``South_z20_5h`` | South | Baseline | 20 deg | 5 hours | +-----------------------+-------+---------------+--------+----------+ - | ``South_z40_5h`` | South | Baseline | 40 deg | 5 hours | - +-----------------------+-------+---------------+--------+----------+ | ``South_z20_0.5h`` | South | Baseline | 20 deg | 30 min | +-----------------------+-------+---------------+--------+----------+ - | ``South_z40_0.5h`` | South | Baseline | 40 deg | 30 min | - +-----------------------+-------+---------------+--------+----------+ - | ``North_z20_50h`` | North | Baseline | 20 deg | 50 hours | - +-----------------------+-------+---------------+--------+----------+ - | ``North_z40_50h`` | North | Baseline | 40 deg | 50 hours | - +-----------------------+-------+---------------+--------+----------+ - | ``North_z20_5h`` | North | Baseline | 20 deg | 5 hours | - +-----------------------+-------+---------------+--------+----------+ - | ``North_z40_5h`` | North | Baseline | 40 deg | 5 hours | - +-----------------------+-------+---------------+--------+----------+ - | ``North_z20_0.5h`` | North | Baseline | 20 deg | 30 min | - +-----------------------+-------+---------------+--------+----------+ - | ``North_z40_0.5h`` | North | Baseline | 40 deg | 30 min | - +-----------------------+-------+---------------+--------+----------+ | ``South_TS_z20_50h`` | South | Threshold | 20 deg | 50 hours | +-----------------------+-------+---------------+--------+----------+ - | ``South_TS_z40_50h`` | South | Threshold | 40 deg | 50 hours | - +-----------------------+-------+---------------+--------+----------+ | ``South_TS_z20_5h`` | South | Threshold | 20 deg | 5 hours | +-----------------------+-------+---------------+--------+----------+ - | ``South_TS_z40_5h`` | South | Threshold | 40 deg | 5 hours | - +-----------------------+-------+---------------+--------+----------+ | ``South_TS_z20_0.5h`` | South | Threshold | 20 deg | 30 min | +-----------------------+-------+---------------+--------+----------+ - | ``South_TS_z40_0.5h`` | South | Threshold | 40 deg | 30 min | - +-----------------------+-------+---------------+--------+----------+ - | ``North_TS_z20_50h`` | North | Threshold | 20 deg | 50 hours | - +-----------------------+-------+---------------+--------+----------+ - | ``North_TS_z40_50h`` | North | Threshold | 40 deg | 50 hours | - +-----------------------+-------+---------------+--------+----------+ - | ``North_TS_z20_5h`` | North | Threshold | 20 deg | 5 hours | - +-----------------------+-------+---------------+--------+----------+ - | ``North_TS_z40_5h`` | North | Threshold | 40 deg | 5 hours | - +-----------------------+-------+---------------+--------+----------+ - | ``North_TS_z20_0.5h`` | North | Threshold | 20 deg | 30 min | - +-----------------------+-------+---------------+--------+----------+ - | ``North_TS_z40_0.5h`` | North | Threshold | 40 deg | 30 min | - +-----------------------+-------+---------------+--------+----------+ .. warning:: The **50 hours** @@ -163,12 +104,25 @@ the pointing direction in Right Ascension and Declination (see figure below). *Header of an event list* .. note:: - The pointing direction during an observation is fixed. + The pointing direction during an observation is fixed. The simulation has + the following characteristics: + + * Number of observations (and pointings): 1673 + * Duration of each observation: 1800 sec + * Deadtime fraction: 5% + * Total exposure time of simulation: 836.5 hours + * Simulated event energies: 30 GeV - 120 TeV + * Maximum off-axis angle: 5 deg + * Start data of observations: 1/1/2021 .. warning:: Only the following header keywords in the ``EVENTS`` table have meaningful values: + * ``DSTYPx`` - Data sub-space type + * ``DSUNIx`` - Data sub-space unit + * ``DSVALx`` - Data sub-space value + * ``DSREFx`` - Data sub-space reference * ``DATE_OBS`` - start date of observation (UTC) * ``TIME_OBS`` - start time of observation (UTC) * ``DATE_END`` - end date of observation (UTC) @@ -222,54 +176,15 @@ An example of an ``EVENTS`` table is shown below. *Content of an event list* -Event files exist for - - +-----------------+---------------+--------------------+------------------+ - | Survey | Configuration | Prefix | Energy range | - +=================+===============+====================+==================+ - | Galactic Centre | Baseline | ``gc_baseline`` | | - +-----------------+---------------+--------------------+------------------+ - | Galactic Plane | Baseline | ``gps_baseline`` | 30 GeV - 120 TeV | - +-----------------+---------------+--------------------+------------------+ - | Extragalactic | Baseline | ``egal_baseline`` | | - +-----------------+---------------+--------------------+------------------+ - | Galactic Centre | Threshold | ``gc_threshold`` | | - +-----------------+---------------+--------------------+------------------+ - | Galactic Plane | Threshold | ``gps_threshold`` | | - +-----------------+---------------+--------------------+------------------+ - | Extragalactic | Threshold | ``egal_threshold`` | | - +-----------------+---------------+--------------------+------------------+ - Observation Definition Files ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The files ``obs_XXX_YYYYY.xml`` are so called -:ref:`Observation Definition Files ` -that contain the information (or metadata) of a list of observations. -The files are plain ASCII files in XML format that can be inspected and +The file ``obs_gc_baseline.xml`` is a so called +:ref:`Observation Definition File ` +that contains the information (or metadata) of a list of observations. +The file is a plain ASCII files in XML format that can be inspected and manipulated by any text editor. -The following files are included in the distribution: - - +----------------------------+--------------------------------------------------------+ - | File | Purpose | - +============================+========================================================+ - | ``obs_gc_baseline.xml`` | Galactic Centre Survey performed with baseline arrays | - +----------------------------+--------------------------------------------------------+ - | ``obs_gc_threshold.xml`` | Galactic Centre Survey performed with threshold arrays | - +----------------------------+--------------------------------------------------------+ - | ``obs_gps_baseline.xml`` | Galactic Plane Survey performed with baseline arrays | - +----------------------------+--------------------------------------------------------+ - | ``obs_gps_threshold.xml`` | Galactic Plane Survey performed with threshold arrays | - +----------------------------+--------------------------------------------------------+ - | ``obs_egal_baseline.xml`` | Extragalactic Survey performed with baseline arrays | - +----------------------------+--------------------------------------------------------+ - | ``obs_egal_threshold.xml`` | Extragalactic Survey performed with threshold arrays | - +----------------------------+--------------------------------------------------------+ - | ``obs_all_baseline.xml`` | All surveys combined performed with baseline arrays | - +----------------------------+--------------------------------------------------------+ - | ``obs_all_threshold.xml`` | All surveys combined performed with threshold arrays | - +----------------------------+--------------------------------------------------------+ Models @@ -281,13 +196,11 @@ The file ``models_gc.xml`` is a so called :ref:`Model Definition File ` that collects the definition of all model components used for the Galactic Centre Survey simulation. -The files ``models_gps.xml`` and ``models_egal.xml`` are the equivalent files -for the Galactic Plane Survey and the Extragalactic Survey. -The other files in the folder are FITS files containing sky maps that were -used as spatial templates for modelling extended or diffuse emission components. +The other files in the folder are ASCII and FITS files containing spectral, +temporal and spatial information that was used in the simulations. .. warning:: - The FITS template files should always reside in the same folder as the + The ASCII and FITS files should always reside in the same folder as the :ref:`model definition XML files ` since the latter reference the former. diff --git a/doc/source/users/tutorials/1dc/event_file.png b/doc/source/users/tutorials/1dc/event_file.png index 4c9f1e6..2b63a95 100644 Binary files a/doc/source/users/tutorials/1dc/event_file.png and b/doc/source/users/tutorials/1dc/event_file.png differ diff --git a/doc/source/users/tutorials/1dc/event_header.png b/doc/source/users/tutorials/1dc/event_header.png index de5d93f..7d80c1f 100644 Binary files a/doc/source/users/tutorials/1dc/event_header.png and b/doc/source/users/tutorials/1dc/event_header.png differ diff --git a/doc/source/users/tutorials/1dc/event_list.png b/doc/source/users/tutorials/1dc/event_list.png index d7014c7..54f8e34 100644 Binary files a/doc/source/users/tutorials/1dc/event_list.png and b/doc/source/users/tutorials/1dc/event_list.png differ diff --git a/doc/source/users/tutorials/1dc/getting_data.rst b/doc/source/users/tutorials/1dc/getting_data.rst index 5a6e9cb..90c6edf 100644 --- a/doc/source/users/tutorials/1dc/getting_data.rst +++ b/doc/source/users/tutorials/1dc/getting_data.rst @@ -3,51 +3,57 @@ Getting the data ================ -The data for the +A pre-release of the data for the :ref:`first CTA Data Challenge ` -are available on the +is available on the `CTA ownCloud server `_. You need your usual CTA credentials to download the data. +The full +:ref:`first CTA Data Challenge ` +data release is planned for the second half of March 2017. -The data have been split in number of tarballs that are summarised in -the following table. You may click on the links in the second column -to download the data. +The pre-release contains simulated data for the Galactic Centre Survey, +:ref:`Instrument Response Functions (IRFs) `, and the +:ref:`model definition files ` +that were used for the simulation. +The data were split into the separate files that can be downloaded +by clicking on the following links: - +-------------------------------+-------------------------------------------------------------------------------+ - | Content | Download link | - +===============================+===============================================================================+ - | Instrument Response Functions | ``_ | - +-------------------------------+-------------------------------------------------------------------------------+ - | Sky and background models | ``_ | - +-------------------------------+-------------------------------------------------------------------------------+ +* `Galactic Centre Survey `_ (5.9 GB) +* `Instrument Response Functions `_ (0.2 MB) +* `Sky and background models `_ (0.9 GB) -You may also download the files using the ``wget`` tool from the command -line by typing (```` needs to be replaced by your CTA user name): +You can also download the files using the ``wget`` tool from the command +line by typing: .. code-block:: bash - $ wget https://owncloud.cta-observatory.org/remote.php/webdav/1dc/caldb.tar.gz --user= --ask-password - $ wget https://owncloud.cta-observatory.org/remote.php/webdav/1dc/models.tar.gz --user= --ask-password + $ wget https://owncloud.cta-observatory.org/remote.php/webdav/1dc.pre/gc-pre.tar.gz --user= --ask-password + $ wget https://owncloud.cta-observatory.org/remote.php/webdav/1dc.pre/caldb-pre.tar.gz --user= --ask-password + $ wget https://owncloud.cta-observatory.org/remote.php/webdav/1dc.pre/models-pre.tar.gz --user= --ask-password .. warning:: - Don't type the ``$`` symbol. It indicates in the following that a command - should be typed on the command line of a console. + ```` needs to be replaced by your CTA user name. + Don't type the ``$`` symbol. It indicates that a command should be typed + on the command line of a console. After downloading, uncompress the files at any place by typing .. code-block:: bash - $ tar xfvz caldb.tar.gz - $ tar xfvz models.tar.gz + $ tar xfvz gc-pre.tar.gz + $ tar xfvz caldb-pre.tar.gz + $ tar xfvz models-pre.tar.gz + +You should now have a folder named ``1dc.pre`` in your current working +directory. -After that you should have the folder ``1dc`` in your current working -directory. Type there the following to set the ``CALDB`` and ``CTADATA`` -environment variables: +Before continuing, please set the following environment variables: .. code-block:: bash - $ export CALDB=$PWD/1dc/caldb - $ export CTADATA=$PWD/1dc/data + $ export CALDB=$PWD/1dc.pre/caldb + $ export CTADATA=$PWD/1dc.pre/data .. note:: You may consider adding the ``CALDB`` and ``CTADATA`` environment variables -- libgit2 0.21.4