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 Database section to assess whether the NDLab dabase fits your needs, and note that for accurate structure and decay description, one should revert to the ENSDF database.

Ndlab is available on GitHub under MIT license,

and it comprises:

• an engine to retrive data and plug them into data manipulation tools like pandas and plotly

• a set of Python classes and functions to write custom code

• a Notebook with tutorial, see the introductory video

 

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

Contents

Installation

• 1. Get NDLab
• 2. Dependencies
• 3. Test it’s working
• 4. Optional packages
  • Pandas and Plotly
  • SQLite DB Browser
• 5. Change log
  • Version v.0.2.2db.0.2.3-beta
  • Version v0.1.2.db.0.2.2-beta
  • Version v0.1.1.db.0.2.2-beta
  • Version v0.1.1.db.0.1.1-beta

Interrogation

• 0. Cheat sheet
• 1. Retrieval functions
• 2. The fields parameter
• 3. The filter parameter
• 4. Examples
• 5. J ^p values
• 6. Decay modes
• 7. Three lines of code
• 8. SQL through Python
• 9. SQL direct connection

Programming

• 0. Cheat sheet
• 1. Programming overview
• 2. Classes and functions
• 3. Pandas
• 3. Work with Measurements
  • Values, Uncertainties, and Limits

Constructing "fields" and "filter"

• 1. Legend
• 2. Entities
  • NUCLIDE
  • LEVEL
  • GAMMA
  • L_DECAY
  • DR_ALPHA
  • DR_BETAM
  • DR_BETAP
  • DR_ANTI_NU
  • DR_NU
  • DR_DELAYED
  • DR_GAMMA
  • DR_PHOTON_TOTAL
  • DR_X
  • DR_AUGER
  • DR_ANNIHIL
  • DR_CONV_EL
  • CUM_FY
  • IND_FY
• 3. Constants
  • Decay modes
  • JP assignment criteria
  • RIPL J and P assignments method
  • Beta decay transition types
  • Atomic shells and vacancies

Code Documentation

• 1. ndlab module
  • Querying the database
  • Managing Values and Uncertainities
  • Functions creating data model classes
  • Data model classes
• 2. ndlaborm module
• 3. ndlabdblink module

The Database

• 1. The search engine
• 2. Underlying databases
  • Levels and gamma transitions
  • Linking Adopted and Decay datasets
• 3. Data sources

The Data API

• 1. Getting the data from the Web
• 2. Parameters and return formats
• 3. Examples
• 4. Deal with HTTP Error 403