.. nuTens documentation master file, created by
   sphinx-quickstart on Mon Jul  7 16:22:03 2025.

nuTens documentation
====================

nuTens is an engine for calculating neutrino oscillation probabilities in an extremely flexible way using tensors, allowing the calculations to be differentiable with fast execution.

.. raw:: html

   <div align="center">

      <img alt="DOI" src = https://zenodo.org/badge/824239795.svg href=https://doi.org/10.5281/zenodo.15873397>
      <img alt="GitHub Release" src = https://img.shields.io/github/v/release/ewanwm/nuTens?color=blue href=https://github.com/ewanwm/nuTens/releases>
      <img alt="PyPI - Version" src = https://img.shields.io/pypi/v/nuTens?color=blue href=https://pypi.org/project/nuTens/>
      <img alt="GitHub License" src = https://img.shields.io/github/license/ewanwm/nuTens?color=green href=https://github.com/ewanwm/nuTens/blob/main/LICENSE>

   </div>

----

.. toctree::

   intro.rst

.. toctree::
   :caption: 🚀 Getting Started

   installation.rst
   quick-start-guide/quick-start-guide.rst

.. toctree::
   :maxdepth: 1
   :caption: 📖 References

   user-manual.rst
   cpp-api.rst
   python-api.rst
   GitHub 🔗 <https://github.com/ewanwm/nuTens>
   Examples 🔗 <https://github.com/ewanwm/nuTens/tree/main/examples>

.. toctree::
   :caption: 🖥️ For Developers

   development.rst