Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs improvement #851

Merged
merged 5 commits into from
Jan 11, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 9 additions & 15 deletions docs/lstchain_api/analysis/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,17 @@
Analysis
========

Module containing scripts to perform :math:`{\theta}^2/{\alpha}` plots using DL2 files.
.. currentmodule:: lstchain.analysis

Submodules
----------
Introduction
============

Module containing scripts to perform :math:`{\theta}^2/{\alpha}` plots using DL2 files.

lstchain.analysis.post\_dl2
---------------------------
Reference/API
=============

.. automodule:: lstchain.analysis.post_dl2
:members:
:undoc-members:
:show-inheritance:
.. automodapi:: lstchain.analysis.post_dl2
:no-inheritance-diagram:

Module contents
---------------

.. automodule:: lstchain.analysis
:members:
:undoc-members:
:show-inheritance:
28 changes: 14 additions & 14 deletions docs/lstchain_api/calib/index.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
.. _calib:

========================
Calibration (``calib``)
========================
======================
Calibration (`calib`)
======================

Module containing functions and classes needed for the Calibration of LST data.
.. currentmodule:: lstchain.calib

Introduction
============

Module contents
---------------
.. automodule:: lstchain.calib.camera
:members:
:undoc-members:
:show-inheritance:
Module containing functions and classes needed for the Calibration of LST data.

.. automodule:: lstchain.calib
:members:
:undoc-members:
:show-inheritance:
Reference/API
=============
.. automodapi:: lstchain.calib
:no-inheritance-diagram:
.. automodapi:: lstchain.calib.camera
:no-inheritance-diagram:
40 changes: 13 additions & 27 deletions docs/lstchain_api/datachecks/index.rst
Original file line number Diff line number Diff line change
@@ -1,34 +1,20 @@
.. _datachecks:

===========================
Datachecks (``datachecks``)
===========================
=========================
Datachecks (`datachecks`)
=========================

Module containing functions producing the LST datachecks. Currently reaching DL1 level.

Submodules
----------

lstchain.datachecks.containers
------------------------------
.. currentmodule:: lstchain.datachecks

.. automodule:: lstchain.datachecks.containers
:members:
:undoc-members:
:show-inheritance:
Introduction
============

lstchain.datachecks.dl1\_checker
--------------------------------

.. automodule:: lstchain.datachecks.dl1_checker
:members:
:undoc-members:
:show-inheritance:
Module containing functions producing the LST datachecks. Currently reaching DL1 level.

Module contents
---------------
Reference/API
=============

.. automodule:: lstchain.datachecks
:members:
:undoc-members:
:show-inheritance:
.. automodapi:: lstchain.datachecks.containers
:no-inheritance-diagram:
.. automodapi:: lstchain.datachecks.dl1_checker
:no-inheritance-diagram:
60 changes: 20 additions & 40 deletions docs/lstchain_api/image/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
.. _image:

=================
Image (``image``)
=================
===============
Image (`image`)
===============

.. currentmodule:: lstchain.image

Introduction
============

Module containing image processing customly implemented in lstchain. This includes:

Expand All @@ -11,42 +16,17 @@ Module containing image processing customly implemented in lstchain. This includ
* Muon fit and analysis.


Submodules
----------

lstchain.image.cleaning
-----------------------

.. automodule:: lstchain.image.cleaning
:members:
:undoc-members:
:show-inheritance:

lstchain.image.modifier
-----------------------

.. automodule:: lstchain.image.modifier
:members:
:undoc-members:
:show-inheritance:

lstchain.image.muon
-------------------

.. automodule:: lstchain.image.muon.muon_analysis
:members:
:undoc-members:
:show-inheritance:

.. automodule:: lstchain.image.muon.plot_muon
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------
Reference/API
=============

.. automodule:: lstchain.image
:members:
:undoc-members:
:show-inheritance:
.. automodapi:: lstchain.image
:no-inheritance-diagram:
.. automodapi:: lstchain.image.cleaning
:no-inheritance-diagram:
.. automodapi:: lstchain.image.modifier
:no-inheritance-diagram:
.. automodapi:: lstchain.image.muon.muon_analysis
:no-inheritance-diagram:
.. automodapi:: lstchain.image.muon.plot_muon
:no-inheritance-diagram:
69 changes: 19 additions & 50 deletions docs/lstchain_api/io/index.rst
Original file line number Diff line number Diff line change
@@ -1,58 +1,27 @@
.. _io:

======================
Input/Output (``io``)
======================
====================
Input/Output (`io`)
====================

`lstchain.io` contains functions and containers to read and write LST data. Also important for the data reading is the `ctapipe_io_lst` library, that contains the event source to read LST data.

Submodules
----------

lstchain.io.config module
-------------------------

.. automodule:: lstchain.io.config
:members:
:undoc-members:
:show-inheritance:

lstchain.io.data\_management module
-----------------------------------
.. currentmodule:: lstchain.io

.. automodule:: lstchain.io.data_management
:members:
:undoc-members:
:show-inheritance:
Introduction
============

lstchain.io.event\_selection module
-----------------------------------

.. automodule:: lstchain.io.event_selection
:members:
:undoc-members:
:show-inheritance:

lstchain.io.io module
---------------------

.. automodule:: lstchain.io.io
:members:
:undoc-members:
:show-inheritance:

lstchain.io.lstcontainers module
--------------------------------
`lstchain.io` contains functions and containers to read and write LST data. Also important for the data reading is the `ctapipe_io_lst` library, that contains the event source to read LST data.

.. automodule:: lstchain.io.lstcontainers
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------
Reference/API
=============

.. automodule:: lstchain.io
:members:
:undoc-members:
:show-inheritance:
.. automodapi:: lstchain.io.config
:no-inheritance-diagram:
.. automodapi:: lstchain.io.data_management
:no-inheritance-diagram:
.. automodapi:: lstchain.io.event_selection
:no-inheritance-diagram:
.. automodapi:: lstchain.io.io
:no-inheritance-diagram:
.. automodapi:: lstchain.io.lstcontainers
:no-inheritance-diagram:
31 changes: 11 additions & 20 deletions docs/lstchain_api/irf/index.rst
Original file line number Diff line number Diff line change
@@ -1,26 +1,17 @@
.. _irf:

======================================
Intrument Response Functions (``irf``)
======================================
====================================
Intrument Response Functions (`irf`)
====================================

Library containing the functions and classes to produce LST IRFs using MC DL2 files.

Submodules
----------
.. currentmodule:: lstchain.io

lstchain.irf.hdu\_table module
------------------------------
Introduction
============

.. automodule:: lstchain.irf.hdu_table
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------
Library containing the functions and classes to produce LST IRFs using MC DL2 files.

.. automodule:: lstchain.irf
:members:
:undoc-members:
:show-inheritance:
.. automodapi:: lstchain.irf.hdu_table
:no-inheritance-diagram:
.. automodapi:: lstchain.irf
:no-inheritance-diagram:
47 changes: 15 additions & 32 deletions docs/lstchain_api/mc/index.rst
Original file line number Diff line number Diff line change
@@ -1,42 +1,25 @@
.. _mc:

===================
MonteCarlo (``mc``)
===================
=================
MonteCarlo (`mc`)
=================

Module containing functions to analyze MC data and compute sensitivity curves.

Submodules
----------
.. currentmodule:: lstchain.mc

lstchain.mc.mc module
---------------------
Introduction
============

.. automodule:: lstchain.mc.mc
:members:
:undoc-members:
:show-inheritance:

lstchain.mc.plot\_utils module
------------------------------
Module containing functions to analyze MC data and compute sensitivity curves.

.. automodule:: lstchain.mc.plot_utils
:members:
:undoc-members:
:show-inheritance:

lstchain.mc.sensitivity module
------------------------------

.. automodule:: lstchain.mc.sensitivity
:members:
:undoc-members:
:show-inheritance:
Reference/API
=============

Module contents
---------------
.. automodapi:: lstchain.mc.mc
:no-inheritance-diagram:
.. automodapi:: lstchain.mc.plot_utils
:no-inheritance-diagram:
.. automodapi:: lstchain.mc.sensitivity
:no-inheritance-diagram:

.. automodule:: lstchain.mc
:members:
:undoc-members:
:show-inheritance:
Loading