.. NDLab documentation master file, created by
   sphinx-quickstart on Wed Aug 10 15:11:47 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.
.. raw:: html

      <div style="float:left;font-size:30px;background-color:rgb(72, 108, 200);width:100%">
       <img src="./_static/ndlab.png" width="300">
       <b></b>    
      </div>

      <div style="margin-bottom:30px">&nbsp;</div>

.. _index-label:

Beta Testing User Guide
=======================

| **NDlab** is a package for nuclear (mainly) structure data analysis, calculation, and modelling. 
| It caters for users that need to process and navigate the data via software, having no knowledge about the formats and data structures of the original data libraries. 

.. attention::

   Please consult the :ref:`Database section <database-label>` to assess whether the NDLab dabase fits your needs, 
   and note that for accurate structure and decay description, one should revert to the `ENSDF <https://nndc.bnl.gov/ensdf>`_ database.


| Ndlab is available on `GitHub <https://github.com/IAEA-NDS/ndlab/>`_ under MIT license,
| and it comprises:

* an engine to retrive data and plug them into data manipulation tools like `pandas <https://pandas.pydata.org/docs/user_guide/10min.html>`_ and `plotly <https://plotly.com/python/>`_

* a set of Python classes and functions to write custom code 
* a Notebook with tutorial, see the introductory video 

.. raw:: html

   <div style="margin-left:100px">
   <iframe width="400" height="250" src="https://www.youtube.com/embed/aBRcrzQwY7Q" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
   </div>
   <div style="margin-bottom:30px">&nbsp;</div>


Its main features are:

* intuitive way to interrogate the database
* smooth connection to Python data analysis and plotting packages
* customizable Pyhton modules to write algorithms and simulations
* automatic propagation of uncertainties when performing calculations
* option to directly access the underlying SQL database
* option to get the data from Nuclear Data Section's servers using API


| In case you wanted to collaborate to the development, you should write
| to nds.contact-point@iaea.org

Hands-on tutorial
-----------------

Besides this documentation, in the package you can find ndlab-tutorial.ipynb, a Notebook with live exercises and examples.

You can preview it without installing, look at the static `HTML version <_static/ndlab-tutorial.html>`_ 



Contents 
========


.. toctree::
   :maxdepth: 2
   :caption: Installation

   installation

.. toctree::
   :maxdepth: 2
   :caption: Interrogation

   interrogation
   
.. toctree::
   :maxdepth: 2
   :caption: Programming 

   programming

.. toctree::
   :maxdepth: 2
   :caption: Constructing "fields" and "filter"

   entities

.. toctree::
   :maxdepth: 2
   :caption: Code Documentation

   code

.. toctree::
   :maxdepth: 2
   :caption: The Database

   database

.. toctree::
   :maxdepth: 2
   :caption: The Data API

   api