.. JADE documentation master file, created by
   sphinx-quickstart on Wed Jun  9 10:32:01 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to JADE's documentation!
================================

JADE is a Verification & Validation (V&V) framework for nuclear data libraries and transport codes.
Use JADE to automatically generate, run and post-process benchmarks and compare the results obtained
using different nuclear data libraries and transport codes combinations.

JADE is an open-source software licensed under the :ref:`gnulicense` and it is
hosted on GitHub `here <https://github.com/JADE-V-V/JADE>`_.

Development was initially started in 2019 by NIER, University of Bologna (UNIBO) and Fusion For Energy (F4E),
and it is today carried out mainly by F4E and the United Kingdom Atomic Energy Authority (UKAEA).
You can find an up to date and detailed list of contributors in the :ref:`contributor_list` section.

When using JADE for scientific publications you are kindly encouraged to cite the following papers:

* Davide Laghi et al, 2020, "JADE, a new software tool for nuclear fusion data libraries verification & validation",
  Fusion Engineering and Design, **161** 112075, doi: https://doi.org/10.1016/j.fusengdes.2020.112075.
* D. Laghi, M. Fabbri, L. Isolan, M. Sumini, G. Shnabel and A. Trkov, 2021,
  "Application Of JADE V&V Capabilities To The New FENDL v3.2 Beta Release",
  *Nuclear Fusion*, **61** 116073. doi: https://doi.org/10.1088/1741-4326/ac121a

For additional information contact: davide.laghi@f4e.europa.eu

For additional information on future developments please check the `issues list on the
GitHub repository <https://github.com/JADE-V-V/JADE/issues>`_.

.. toctree::
   :maxdepth: 3
   :caption: JADE:

   usage/usage_idx
   dev/dev_idx
   benchmarks/benchmark_idx
   about/publications


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

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