diff --git a/doc/source/users/reference_manual/index.rst b/doc/source/users/reference_manual/index.rst index 5782349..c00341f 100755 --- a/doc/source/users/reference_manual/index.rst +++ b/doc/source/users/reference_manual/index.rst @@ -1,162 +1,87 @@ .. _reference: - - Reference Manual ================ - This manual provides reference information for all ctools and csripts. - General information on ctools usage can be found `here - <../user_manual/introduction.html>`_. The description of user parameters in the reference - manual is documented `here `__. - - - - Below you find links to the command line reference for all available tools and scripts. - - ctools ------ - - .. toctree:: :maxdepth: 1 - - ctbin --- Generates counts cube - ctbkgcube --- Generates background cube - ctbutterfly --- Compute butterfly - ctcubemask --- Filter counts cube - ctedispcube --- Generates energy dispersion cube - cterror --- Calculates likelihood profile errors - ctexpcube --- Generates exposure cube - ctfindvar --- Search for source variability - ctlike --- Performs maximum likelihood fitting - ctmapcube --- Generates a map cube - ctmodel --- Computes model counts cube - ctobssim --- Simulate observations - ctphase --- Computes the phase of each event - ctprob --- Computes event probability for a given model - ctpsfcube --- Generates point spread function cube - ctselect --- Selects event data - ctskymap --- Generates sky map - cttsmap --- Generates Test Statistic map - ctulimit --- Calculates upper limit - - - - cscripts -------- - - .. toctree:: :maxdepth: 1 - - - csscs --- ToDo: Describe what script is doing csbkgmodel --- Generates background model for 3D analysis - cscaldb --- Lists available instrument response functions - csebins --- Generates energy boundaries for stacked analysis - cslightcrv --- Computes light curve - csmodelinfo --- Shows model container content - csmodelmerge --- Merges several model containers into one file - csmodelselect --- Select models from model definition file - csmodelsois --- Generate map cube from subset of models - csobsdef --- Generates observation definition file - csobsinfo --- Shows observation container content - csobsselect --- Select observations from observation definition file - csphagen --- Generates PHA, ARF, RMF files based on source/background regions - csphasecrv --- Computes phase curve - cspull --- Generates pull distribution - csresmap --- Generates residual map - csresspec --- Generates residual spectrum - csroot2caldb --- Creates a caldb entry from a ROOT file - + csscs --- Performs spectral component separation cssens --- Computes CTA sensitivity - csspec --- Computes spectral points - cssrcdetect --- Detects sources in sky map - cstsdist --- Generates Test Statistic distribution - cstsmapmerge --- Merges slices from Test Statistic map computations - cstsmapsplit --- Creates commands to split the Test Statistic map computations - csviscube --- Computes visibility cube - - - - Scripts to manage an IACT database ---------------------------------- - - .. warning:: - - The ``csiactdata``, ``csiactobs``, ``csfindobs`` and ``csiactcopy`` scripts - rely on the ``json`` Python module which is only available in Python 2.6 - or higher. These scripts will not work on older Python versions. @@ -165,15 +90,9 @@ Scripts to manage an IACT database :maxdepth: 1 - - csobs2caldb --- Creates a caldb entry from an input observation - csiactdata --- Shows information about IACT data available on the user machine - csiactobs --- Generates observation definition file for IACT data from observation IDs - csfindobs --- Generates a list of IACT observation IDs - csiactcopy --- Copies IACT data from one location to another