.. _xrtpy-documentation:

*******************
XRTpy Documentation
*******************

.. image:: _static/images/XRTpy_logo.png
   :alt: XRTpy logo
   :align: center
   :scale: 50%

Welcome to the documentation for **XRTpy** (version |version|) — a Python_ package for analyzing data from the `X-Ray Telescope`_ (XRT) :cite:p:`golub:2007` aboard the Hinode_ spacecraft :cite:p:`kosugi:2007`.

XRTpy is designed for solar physicists, astronomers, students, and anyone curious about the Sun's dynamic outer atmosphere.
Whether you're conducting research or just beginning to explore the world of X-ray solar imaging, XRTpy gives you the tools to study the hot plasma of the solar corona using real space-based observations.

.. toctree::
   :maxdepth: 1
   :caption: Contents:

   about_xrt
   install
   getting_started
   generated/gallery/index
   reference/index
   acknowledging_xrtpy
   bibliography
   glossary
   feedback_communication
   contributing
   code_of_conduct
   changelog/index