======
ARIANE
======

.. image:: https://img.shields.io/badge/DOI-10.1038%2Fs41467--023--37418--8-blue
  :alt: Journal
  :target: https://doi.org/10.1038/s41467-023-37418-8

.. image:: https://img.shields.io/badge/arXiv-2209.00980-red
  :alt: arXiv
  :target: https://arxiv.org/abs/2209.00980

**Reference:** Teixeira Parente, M., Brandl, G., Franz, C., Stuhr, U., Ganeva, M., & Schneidewind, A. (2023).
Active learning-assisted neutron spectroscopy with log-Gaussian processes.
*Nat. Commun.* **14**, 2246.

**Repository:** `https://jugit.fz-juelich.de/ainx/ariane/ <https://jugit.fz-juelich.de/ainx/ariane/>`_

-----

*ARIANE* (**AR**\ tificial **I**\ ntelligence-**A**\ ssisted **N**\ eutron **E**\ xperiments) is a software application developed in the research project *AINX* (**A**\ rtificial **I**\ ntelligence for **N**\ eutron and **X**-ray scattering).
It assists workflows at different types of neutron scattering instruments to improve their efficiency and make better use of the experimenter's time.

The code is designed to include general elements which can be used for the different neutron scattering techniques as applications.

ARIANE has implementations for the following applications:

- | **Three-axes spectroscopy (TAS)**
  | It implements the probabilistic active learning approach described in the reference to find experimental strategies (measurement locations) that are more efficient than grid approaches.

.. image:: /media/ineff-eff-tas.png
  :alt: Inefficient and efficient TAS experiments
  :width: 70%
  :align: center

-----

User documentation
==================

General
-------

.. toctree::
   :maxdepth: 1
   
   /user/general/install
   /user/general/archit

TAS
---

.. toctree::
   :maxdepth: 1
   
   /user/tas/workfl-gener
   /user/tas/getting-started
   /user/tas/workfl-exten
   /user/tas/diagnostics

Developer documentation
=======================

General
-------

.. toctree::
   :maxdepth: 1
   
   /developer/general/comm-protoc
   /developer/general/impl
   /developer/general/tests
   /developer/general/contrib
   /developer/general/api

TAS
---

.. toctree::
   :maxdepth: 1
   
   /developer/tas/comm-protoc
   /developer/tas/impl
   /developer/tas/forma
   /developer/tas/tests

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

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