NuPaAc - Nuclide Pandas Accessor

This python package provides the NuclideSeriesAccessor class, which acts as kind of wrapper to interact with radioactivedecay Nuclide objects from nuclide strings containing pandas Series. For detailed information about the radioactivedecay package, see its documentation.

The series accessor allows to retrive several data series obtained from the dataset in use by radioactivedecay. Where appropriate, data are returned as pint series, allowing to preserve the unit and perform unit-aware operations. The functionality is implemented via the pint-pandas package.

Consult the tutorial.md file to learn about the functionality provided by this package.

The project is currently under development and changes in its behaviour might be introduced.

Installation

Install the latest release of NuPaAc from PyPI via pip:

$ pip install nupaac

The development version can be installed from the Git repository using pip:

# Via https
pip install git+https://codeberg.org/Cs137/NuPaAc.git

# Via ssh
pip install git+ssh://git@codeberg.org:Cs137/NuPaAc.git

Usage

The pandas Series accessor is available via the nucs attribute of Series instances. In order to make use of the accessor, import the module nucs from this package.

Examples demonstrating several use cases can be found in the tutorial.md file.

Changes

All notable changes to this project are documented in the CHANGELOG.md file.

Contributing

Contributions to the NuPaAc package are very welcomed. Feel free to submit a pull request, if you would like to contribute to the project. In case you are unfamiliar with the process, consult the forgejo documentation and follow the steps using this repository instead of the example repository.

Create your pull request (PR) to inform that you start working on a contribution. Provide a clear description of your envisaged changes and the motivation behind them, prefix the PR's title with WIP: until your changes are finalised.

All kind of contributions are appreciated, whether they are bug fixes, new features, or improvements to the documentation.

Development

Installing for development

To install the package in development mode, clone the Git repository and install the package using Poetry, as shown in the code block underneath. To install Poetry, which is required for virtual environment and dependency management, follow the instructions on the Poetry website.

git clone https://codeberg.org/Cs137/NuPaAc.git
cd nupaac
poetry install

This will create a virtual environment and install the package dependencies and the package itself in editable mode, allowing you to make changes to the code and see the effects immediately in the corresponding virtual environment. Alternatively, you can install it via pip install -e in an existing virtual environment.

License

NuPaAc is open source software released under the MIT License. See LICENSE file for details.

This package was created and is maintained by Christian Schreinemachers, (C) 2025.