feign

feign: a Python package to estimate geometric efficiency in passive gamma spectroscopy measurements of nuclear fuel - Published in JOSS (2019)

https://github.com/ezsolti/feign

Science Score: 95.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 1 DOI reference(s) in JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org
  • Committers with academic emails
    2 of 7 committers (28.6%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software
Last synced: 6 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: ezsolti
  • License: mit
  • Language: Python
  • Default Branch: master
  • Size: 2.9 MB
Statistics
  • Stars: 1
  • Watchers: 0
  • Forks: 2
  • Open Issues: 0
  • Releases: 1
Created over 6 years ago · Last pushed over 5 years ago
Metadata Files
Readme License

README.md

status

FEIGN: a package to estimate the geometric efficiency of gamma spectroscopy setups in spent nuclear fuel measurements

feign is a python package for estimating the geometric efficiency in passive gamma spectroscopy measurements of spent nuclear fuel assemblies. It implements a 2D point-kernel method without build-up factors (ie. an "uncollided F5 tally" as known by MCNP users). The name feign implies that the program pretends to be a transport code, however it is rather a ray-tracing code.

It is intended for nuclear safeguards specialists and nuclear engineers who want to get a quick estimate on the geometric efficiency in their passive gamma setup. It might be also useful to people working with passive gamma emission tomography of spent fuel.

The feign API allows the user to define the geometry of a rectangular fuel assembly, which is built of pins (nested annular material regions). The user also defines the composition of materials present in the simulation, the detector points where the efficiency needs to be evaluated, and optionally collimators and absorber elements.

As a package, feign provides

  • basic 2D geometry classes (Point, Segment, Circle, Rectangle)
  • classes to describe materials, fuel pins, rectangular fuel assemblies, detectors and absorbers
  • methods to perform the ray-tracing and estimating the geometric efficiency.

Installation

feign can be installed by downloading the zipball from github.

bash pip install https://github.com/ezsolti/feign/zipball/master

Installation was successfully tested on Linux and Windows.

Uninstall it with the command

bash pip uninstall feign

Dependencies

  • NumPy
  • Matplotlib

Data

Besides the installation you will need mass attenuation coefficients. You can download some files for testing from the data folder. Further information on how to obtain your own data is an the documentation site. When you have gathered your own datafiles, you can link them to Material() objects with the following method:

python uo2=Material('1') uo2.set_path(('/yourpath/UO2.dat',1))

set_path expects a tuple, the first element is the path to the data file, and the second element clarifies which column should be used from the file (since you might have several columns, for example attenuaton with or without coherent scattering).

Getting started

The basic functionality and the theoretical background is summarized at the documentation site

Examples

Several examples can be found in the examples folder or at the documentation site

Docs

API documentation, examples and theoretical background is covered at ezsolti.github.io/feign

Contributing, bugs, suggestions

Any reported bug or suggestion is appreciated, please open a new issue. If you would like to contribute, do not hesitate to do so, just include tests.

Tests

Several tests can be found in the tests folder, run them with

bash python3 -m unittest discover tests/

Licence

This work is licensed under the MIT License (see LICENSE)

Owner

  • Login: ezsolti
  • Kind: user

JOSS Publication

feign: a Python package to estimate geometric efficiency in passive gamma spectroscopy measurements of nuclear fuel
Published
October 13, 2019
Volume 4, Issue 42, Page 1650
Authors
Zsolt Elter ORCID
Uppsala University, Division of Applied Nuclear Physics
Aron Cserkaszky ORCID
Pazmany Peter Catholic University, Faculty of Information Technology
Sophie Grape ORCID
Uppsala University, Division of Applied Nuclear Physics
Editor
Kathryn Huff ORCID
Tags
nuclear safeguards gamma spectroscopy ray tracing

GitHub Events

Total
Last Year

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 197
  • Total Committers: 7
  • Avg Commits per committer: 28.143
  • Development Distribution Score (DDS): 0.503
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
ezsolti e****t@g****m 98
zsolt z****t@p****e 85
aron cserkaszky a****y@g****m 6
Sophie Grape s****e@p****e 4
Daniel S. Katz d****z@i****g 2
Peter Jansson p****n@m****m 1
Lorena A. Barba l****a@g****u 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 1
  • Total pull requests: 8
  • Average time to close issues: 5 days
  • Average time to close pull requests: 1 day
  • Total issue authors: 1
  • Total pull request authors: 5
  • Average comments per issue: 2.0
  • Average comments per pull request: 0.5
  • Merged pull requests: 6
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • sskutnik (1)
Pull Request Authors
  • kanor (3)
  • sophiegrape (2)
  • ghost (1)
  • labarba (1)
  • danielskatz (1)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

setup.py pypi
  • matplotlib *
  • numpy *