.. _MainPage:

xAODAnaHelpers
==============

.. image:: https://zenodo.org/badge/35496971.svg
   :target: https://zenodo.org/badge/latestdoi/35496971

.. image:: https://travis-ci.org/UCATLAS/xAODAnaHelpers.svg?branch=main
    :target: https://travis-ci.org/UCATLAS/xAODAnaHelpers

.. raw:: html

  <br />


|release_badges|_

.. _release_badges: Installing.html#cmake

The xAOD analysis framework, born out of ProofAna...or not.

Welcome to the xAODAnaHelpers wiki! This is an xAOD Analysis Framework built for Run II of ATLAS.

Supported releases
------------------

xAODAnaHelpers supports 21 and 22 releases. This documentation is for R22, please follow this `link <https://xaodanahelpers.readthedocs.io/en/r21-main/>`_ to see the documentation for R21.

.. _Versions:

Latest Version
--------------

.. Cannot bold just yet: http://stackoverflow.com/questions/33537747/substitution-inside-inline-markup-while-escaping-whitespace

.. note::
    If you need to add a new release to be supported, please make sure you update the GitHub Actions `ci.yml <https://github.com/UCATLAS/xAODAnaHelpers/blob/main/.github/workflows/ci.yml>`_ workflow file first.

We support the following releases: |all_releases|

Python Code Quality
-------------------

.. image:: https://landscape.io/github/UCATLAS/xAODAnaHelpers/main/landscape.svg?style=flat
   :target: https://landscape.io/github/UCATLAS/xAODAnaHelpers/main
   :alt: Code Health

Contents
--------

.. toctree::
   :maxdepth: 2

   Intro
   Installing
   UsingUs
   Algorithms
   Development
   Community
   FAQs
   API
   api/library_root

Indices and tables
==================

* :ref:`genindex`
* :ref:`search`