Python implementation of liquid metal properties from Handbook on Lead-bismuth Eutectic Alloy and Lead Properties, Materials Compatibility, Thermal-hydraulics and Technologies
Project description
- Contributor:
Gabriele Ottino, Lucie Kerleau, Chloé Largeron
- Date:
- 08/01/2024
Introduction
lbh15 (Lead Bismuth Handbook 2015) is a Python package that implements the thermo-physical and the thermo-chemical properties of lead, bismuth and lead-bismuth eutectic (lbe) metal alloy available from the handbook edited by OECD/NEA
lbh15 is released under the GNU Lesser General Public License 3.
lbh15 is listed among the Open-source Nuclear Codes for Reactor Analysis (ONCORE) by IAEA.
Project Structure
The project is organized according to the following folder structure:
<lbh15 parent folder>
├── docs/
├── lbh15/
├── tests/
├── tutorials/
├── CHANGELOG.rst
├── LICENSE
├── MANIFEST.in
├── README.rst
├── pyproject.toml
└── setup.py
lbh15: contains all modules, classes and methods implemented in lbh15;
docs: contains files for the generation of the documentation by Sphinx;
tests: collection of tests used to verify the correct implementation;
tutorials: collection of tutorials and examples, each one into a dedicated sub-folder.
Dependencies
To run the code, the following dependencies must be satisfied:
Python \(>= 3.8.10\)
SciPy \(>= 1.8.1\)
NumPy \(>= 1.22.3\)
To build the documentation in both html and LaTeX formats, the following dependencies must be satisfied:
sphinx \(>= 6.2.1\)
sphinx-rtd-theme \(>= 1.3.0\)
myst-parser \(>= 1.0.0\)
sphinxcontrib-bibtex \(>= 2.5.0\)
Installation
To install the lbh15 package, please type the following command:
pip install lbh15
Or use https://github.com/newcleo-dev-team/lbh15.git to clone the package. After cloning the package, execute the following command inside the base folder:
pip install .
To upgrade the lbh15 package, please type the install command along with the --upgrade or -U flag:
pip install --upgrade lbh15
Documentation
The Sphinx documentation can be built in html and LaTeX formats by executing the following command in the folder docs/:
make html
make latexpdf
The html documentation is available on GitHub Pages at newcleo-dev-team.github.io/lbh15.
To see the available templates for generating the documentation in PDF format and to choose among them, please look at the docs/conf.py file.
How to Cite
@inproceedings{NURETH20lbh15,
author = {Panico, Daniele and Tomatis, Daniele},
title = {{lbh15: a Python package implementing lead, bismuth, and lead-bismuth eutectic thermophysical properties for fast reactor applications}},
booktitle = {Proc. of 20th International Topical Meeting on Nuclear Reactor Thermal Hydraulics (NURETH-20), Washington DC, USA},
pages = {1--12},
year = {2023},
month = {Aug 20--25},
editor = {ANS}
}
@article{lbh15JOSS2024,
author = {Ottino, G.M., Panico, D., Tomatis, D. and Pantel, P.A.},
title = {{lbh15: a Python package for standard use and implementation of physical data of heavy liquid metals used in nuclear reactors}},
editor = {Journal of Open-Source Scientific Software}
note={submitted}
}
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.