lbh15

lbh15: a Python package for standard use and implementation of physical data of heavy liquid metals used in nuclear reactors - Published in JOSS (2024)

https://github.com/newcleo-dev-team/lbh15

Science Score: 93.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 4 DOI reference(s) in README and JOSS metadata
✓
Academic publication links
Links to: joss.theoj.org
○
Committers with academic emails
○
Institutional organization owner
✓
JOSS paper metadata
Published in Journal of Open Source Software

Keywords

liquid-metal nuclear-reactor thermodynamic-properties

Scientific Fields

Mathematics Computer Science - 84% confidence

Last synced: 6 months ago · JSON representation

Repository

Compilation of thermo-physical properties for lead/bismuth-based liquid metals for fast reactor technology

Basic Info

Host: GitHub
Owner: newcleo-dev-team
License: lgpl-3.0
Language: Python
Default Branch: master
Homepage:
Size: 5.55 MB

Statistics

Stars: 7
Watchers: 3
Forks: 2
Open Issues: 24
Releases: 6

Topics

liquid-metal nuclear-reactor thermodynamic-properties

Created over 3 years ago · Last pushed over 1 year ago

Metadata Files

Readme Changelog License Code of conduct

README.rst

lbh15
=====

.. image:: https://joss.theoj.org/papers/10.21105/joss.06383/status.svg
   :target: https://doi.org/10.21105/joss.06383

:Author: Daniele Panico, Daniele Tomatis
:Contributor: Gabriele Ottino, Lucie Kerleau, Chloé Largeron
:Date: 04/04/2024

Introduction
------------

*lbh15* (**L**\ ead **B**\ ismuth **H**\ andbook 20\ **15**) 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* offers a standard implementation for use of these properties in scientific applications.
In particular, this package is used for numerical simulation and experimental activities supporting the
development of nuclear reactors that employ heavy liquid metals as primary coolant.

*lbh15* is developed by the **Codes & Methods** group of `newcleo `_ and it 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:

.. code:: text

  
    ├── 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`` :math:`>= 3.8.10`
- ``SciPy`` :math:`>= 1.8.1`
- ``NumPy`` :math:`>= 1.22.3`

To build the documentation in both *html* and *LaTeX* formats, the following dependencies must be satisfied:

- ``sphinx`` :math:`>= 6.2.1`
- ``sphinx-rtd-theme`` :math:`>= 1.3.0`
- ``myst-parser`` :math:`>= 1.0.0`
- ``sphinxcontrib-bibtex`` :math:`>= 2.5.0`

Installation
------------

To install the *lbh15* package, please type the following command:

  .. code-block:: bash

      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:

  .. code-block:: bash

      pip install .

To upgrade the *lbh15* package, please type the ``install`` command along with the ``--upgrade`` or ``-U`` flag:

  .. code-block:: bash

      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/``:

  .. code-block:: bash

      make html

  .. code-block:: bash

      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 Contribute
-----------------

For anyone wishing to contribute to the development of the project, report issues
or problems with the software, or request support, please refer to this
`web page `_.

How to Cite
-----------

.. code-block:: latex

  @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}
  }


.. code-block:: latex

  @article{ottino2024lbh15,
    title={lbh15: a Python package for standard use and implementation of physical data of heavy liquid metals used in nuclear reactors},
    author={Ottino, Gabriele and Panico, Daniele and Tomatis, Daniele and Pantel, Pierre-Alexandre},
    journal={Journal of Open Source Software},
    volume={9},
    number={96},
    pages={6383},
    year={2024}
  }

Owner

Name: newcleo
Login: newcleo-dev-team
Kind: organization
Location: Italy

Website: https://www.newcleo.com
Repositories: 2
Profile: https://github.com/newcleo-dev-team

GitHub page of the newcleo development team

JOSS Publication

lbh15: a Python package for standard use and implementation of physical data of heavy liquid metals used in nuclear reactors

Published

April 05, 2024

DOI

10.21105/joss.06383

Volume 9, Issue 96, Page 6383

Authors

Gabriele Ottino

newcleo Srl, via Giuseppe Galliano 27, 10129 Torino, Italy

Daniele Panico
newcleo Srl, via Giuseppe Galliano 27, 10129 Torino, Italy

Daniele Tomatis

newcleo Srl, via Giuseppe Galliano 27, 10129 Torino, Italy

Pierre-Alexandre Pantel
newcleo SA, 9 Rue des Cuirassiers, 69003 Lyon, France

Editor

Kelly Rowland

GitHub Events

Total

Issues event: 4
Watch event: 1
Issue comment event: 11
Push event: 2
Pull request review event: 1
Pull request event: 4
Create event: 2

Last Year

Issues event: 4
Watch event: 1
Issue comment event: 11
Push event: 2
Pull request review event: 1
Pull request event: 4
Create event: 2

Committers

Last synced: 7 months ago

All Time

Total Commits: 556
Total Committers: 11
Avg Commits per committer: 50.545
Development Distribution Score (DDS): 0.696

Past Year

Commits: 2
Committers: 1
Avg Commits per committer: 2.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
Gabriele Ottino	g**1@g**m	169
newcleo	n**o@u**m	157
Daniele Panico	d**o@n**m	149
klucie	l**u@n**m	48
Administrator	a**n@e**m	14
ndarmage	d**s@o**m	6
CLargeron	c**n@n**m	5
Daniele Tomatis	d**s@n**m	4
Lucie Kerleau	l**u@a**l	2
Gabriele Ottino	g**o@a**l	1
CLargeron	c**n@B**L	1

Committer Domains (Top 20 + Academic)

newcleo.com: 4 ubuntu.com: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 68
Total pull requests: 38
Average time to close issues: 21 days
Average time to close pull requests: 3 days
Total issue authors: 8
Total pull request authors: 3
Average comments per issue: 1.9
Average comments per pull request: 0.76
Merged pull requests: 38
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 5
Pull requests: 2
Average time to close issues: 2 days
Average time to close pull requests: 1 day
Issue authors: 3
Pull request authors: 1
Average comments per issue: 1.4
Average comments per pull request: 0.0
Merged pull requests: 2
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

lelaus (31)
prisma34 (13)
papantel (8)
panDanieleN (6)
damar-wicaksono (3)
LukeSeifert (2)
marc-antoine-lafay (1)
mragey (1)

Pull Request Authors

lelaus (45)
panDanieleN (12)
prisma34 (12)

Top Labels

Issue Labels

enhancement (22) documentation (15) bug (10) wontfix (1)

Pull Request Labels

enhancement (8)

Packages

Total packages: 1
Total downloads:
- pypi 31 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 6
Total maintainers: 1

pypi.org: lbh15

Python implementation of liquid metal properties from Handbook on Lead-bismuth Eutectic Alloy and Lead Properties, Materials Compatibility, Thermal-hydraulics and Technologies

Documentation: https://lbh15.readthedocs.io/
License: lgpl v3
Latest release: 2.1.0
published almost 2 years ago

Versions: 6
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 31 Last month

Rankings

Dependent packages count: 6.6%

Average: 23.4%

Dependent repos count: 30.6%

Downloads: 33.1%

Maintainers (1)

newcleo-dev-team

Last synced: 6 months ago

Dependencies

setup.py pypi

numpy >=1.22.3
scipy >=1.8.1

.github/workflows/main.yml actions

actions/checkout v3 composite

.github/workflows/pages.yml actions

actions/checkout v3 composite
actions/deploy-pages v1 composite
actions/upload-pages-artifact v1 composite
ammaraskar/sphinx-action master composite

pyproject.toml pypi

numpy >=1.22.3
scipy >=1.8.1

lbh15

Science Score: 93.0%

Keywords

Scientific Fields

Repository

Basic Info

Statistics

Topics

Metadata Files

README.rst

Owner

JOSS Publication

lbh15: a Python package for standard use and implementation of physical data of heavy liquid metals used in nuclear reactors

Authors

Editor

Tags

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: lbh15

Rankings

Maintainers (1)

Dependencies