.. currentmodule:: nectarchain
Version: |version| Date: |today|
Useful links: Source Repository | Issue Tracker | Discussions
License: BSD-3
Python: |python_requires|
nectarchain is intended for the high level analysis of the NectarCAM data. It is heavily based on ctapipe, adding custom code for NectarCAM calibration.
.. toctree::
:maxdepth: 1
:hidden:
user-guide/index
developer-guide/index
API reference <_autosummary/nectarchain>
.. grid:: 1 2 2 3
.. grid-item-card::
:octicon:`book;40px`
User Guide
^^^^^^^^^^
Learn how to get started as a user. This guide
will help you install nectarchain.
+++
.. button-ref:: user-guide/index
:expand:
:color: primary
:click-parent:
To the user guide
.. grid-item-card::
:octicon:`person-add;40px`
Developer Guide
^^^^^^^^^^^^^^^
Learn how to get started as a developer.
This guide will help you install nectarchain for development
and explains how to contribute.
+++
.. button-ref:: developer-guide/index
:expand:
:color: primary
:click-parent:
To the developer guide
.. grid-item-card::
:octicon:`code;40px`
API Docs
^^^^^^^^
The API docs contain detailed descriptions of
of the various modules, classes and functions
included in nectarchain.
+++
.. button-ref:: _autosummary/nectarchain
:expand:
:color: primary
:click-parent:
To the API docs