Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Paper #240

Open
wants to merge 48 commits into
base: main
Choose a base branch
from
Open

Paper #240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
051a9e1
add skeleton markdown paper
jvavrek Feb 20, 2021
b558365
add a short first draft, only, ~210 words
jvavrek Feb 22, 2021
332708f
add a short first draft, only ~210 words
jvavrek Feb 22, 2021
3234259
Merge branch 'paper' of github.com:lbl-anp/becquerel into paper
jvavrek Feb 22, 2021
f06ef06
summary updates
jvavrek Feb 23, 2021
4a050f6
update table format, add text on data
jvavrek Feb 23, 2021
afafa19
add one article to paper.bib
jvavrek Feb 23, 2021
f481a19
add citation
jvavrek Feb 23, 2021
c8dbfd7
formatting, bp affiliation
jvavrek Feb 23, 2021
0e977a7
Fix markdown table formatting: affiliation needed name
jvavrek Feb 23, 2021
8e574cc
Merge branch 'main' into paper
jvavrek Feb 23, 2021
49e0801
add paper from Mark
jvavrek Feb 24, 2021
8774db5
add Marco's conference record
jvavrek Feb 24, 2021
1817f5c
slight wording change
jvavrek Feb 24, 2021
c2bea29
update summary
jvavrek Mar 2, 2021
6fc1247
update last paragraph
jvavrek Mar 2, 2021
f9e75cd
Merge branch 'main' into paper
jvavrek Mar 4, 2021
0cf714d
uncertainties and lmfit -> pandas and numba
jvavrek Mar 4, 2021
2677bfd
refs for nist xcom and nndc
jvavrek Mar 4, 2021
7f11699
Merge branch 'main' into paper
jvavrek Mar 4, 2021
e9aee85
update author list, date
jvavrek Mar 4, 2021
e75e42f
Merge branch 'main' into paper
jvavrek Mar 5, 2021
f5d85da
Merge branch 'main' into paper
jvavrek Mar 27, 2021
ac48c29
Merge branch 'main' into paper
jvavrek Apr 22, 2021
83f27c3
mention rebinning in paper.md
jvavrek Apr 22, 2021
64750a6
Merge branch 'main' into paper
jvavrek May 13, 2021
4e65ed6
update proceeding to APS paper
jvavrek May 14, 2021
75cca13
Merge branch 'main' into paper
jvavrek May 14, 2021
4f6a0db
Merge branch 'main' into paper
jvavrek Oct 12, 2021
d2b23f0
add references to independent codes
jvavrek Oct 12, 2021
8ce81b9
add refs to paper.bib
jvavrek Oct 12, 2021
9f36f4f
fix end of file line
jvavrek Oct 12, 2021
841f689
try bibliography field
jvavrek Oct 12, 2021
34410d0
revert
jvavrek Oct 12, 2021
ca7690b
try verbatim in bib
jvavrek Oct 12, 2021
61a08b0
try \tt in bib
jvavrek Oct 12, 2021
8cc515f
fix a \tt, double {} NNDC author
jvavrek Oct 12, 2021
85019e6
try corresp auth to resolve pdf issue
jvavrek Oct 12, 2021
fec2dc4
Merge branch 'main' into paper
jvavrek Oct 12, 2021
97c8004
add placeholder acknowledgement for now
jvavrek Oct 12, 2021
7328e19
add dan to author list
jvavrek Oct 12, 2021
e37b475
fix typo
jvavrek Oct 12, 2021
9608e75
Merge branch 'main' into paper
jvavrek Oct 12, 2021
1415af2
Merge branch 'main' into paper
jvavrek Oct 13, 2021
ce0f20b
Merge branch 'main' into paper
jvavrek Oct 13, 2021
57d62c5
add Micah
jvavrek May 31, 2022
56fbf93
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] May 31, 2022
688e7e6
update refs
jvavrek May 31, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 85 additions & 0 deletions paper/paper.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
@online{unzueta_gamma,
author = {Ayllon Unzueta, Mauricio},
title = {{\tt NASA-gamma}},
year = {2021},
url = {https://github.com/mauricioAyllon/NASA-gamma/},
urldate = {2021-10-12}
}

@online{sandia_interspec,
author = {{Sandia National Laboratories}},
title = {{\tt InterSpec v1.0.8}},
year = {2021},
url = {https://github.com/sandialabs/InterSpec/},
urldate = {2021-10-12}
}

@online{morrell_curie,
author = {Morrell, Jonathan},
title = {{\tt curie}},
year = {2021},
url = {https://github.com/jtmorrell/curie},
urldate = {2021-10-12}
}

@techreport{xcom,
author = {Berger,M.J. and Hubbell,J.H. and Seltzer,S.M. and Chang,J. and Coursey,J.S. and Sukumar,R. and Zucker,D.S. and Olsen,K.},
title = {XCOM: Photon Cross Sections Database},
institution = {NIST Standard Reference Database 8},
year = {2010},
doi = {10.18434/T48G6X},
}

@online{nndc,
author = {{National Nuclear Data Center}},
title = {{NuDat} 2},
year = 2021,
url = {https://www.nndc.bnl.gov/nudat2/help/index.jsp},
urldate = {2021-03-04}
}

@article{vavrek2020reconstructing,
title={Reconstructing the Position and Intensity of Multiple Gamma-Ray Point Sources with a Sparse Parametric Algorithm},
author={Vavrek, Jayson R and Hellfeld, Daniel and Bandstra, Mark S and Negut, Victor and Meehan, Kathryn and Vanderlip, William Joe and Cates, Joshua W and Pavlovsky, Ryan and Quiter, Brian J and Cooper, Reynold J and others},
journal={IEEE Transactions on Nuclear Science},
volume={67},
number={11},
pages={2421--2430},
year={2020},
publisher={IEEE}
}

@article{bandstra2020modeling,
title={Modeling Aerial Gamma-Ray Backgrounds using Non-negative Matrix Factorization},
author={Bandstra, MS and Joshi, THY and Bilton, KJ and Zoglauer, A and Quiter, BJ},
journal={IEEE Transactions on Nuclear Science},
volume={67},
number={5},
pages={777--790},
year={2020},
publisher={IEEE}
}

@article{salathe2021determining,
title={Determining urban material activities with a vehicle-based multi-sensor system},
author={Salathe, M and Quiter, BJ and Bandstra, MS and Curtis, JC and Meyer, R and Chow, CH},
journal={Physical Review Research},
volume={3},
number={2},
pages={023070},
year={2021},
publisher={APS}
}

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alihanks can you comment on DoseNet/Radwatch publications?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Anyone else know if DoseNet/Radwatch have used becquerel?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes. @alihanks 👀 thoughts here? Thanks!

@inproceedings{lamb2021cylindrical,
title={{CAMIS: A Cylindrical Active Mask Imaging System}},
author={Lamb, C and Hanks, J and Hellfeld, D and Ellin, J and Marshall, M and Cooper, R and Quiter, B and Vetter, K},
year={2021},
booktitle={{2021 IEEE Nuclear Science Symposium and Medical Imaging Conference}},
}

@online{radwatch,
title={{Berkeley RadWatch}},
url={https://radwatch.berkeley.edu/},
urldate = {2022-05-31}
}
52 changes: 52 additions & 0 deletions paper/paper.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
title: "Becquerel: a Python package for analyzing nuclear spectroscopic measurements"
tags:
- Python
- nuclear engineering
- spectroscopy
- calibration
- peak fitting
- nuclear data
authors:
jvavrek marked this conversation as resolved.
Show resolved Hide resolved
- name: Jayson R. Vavrek^[corresponding author]
affiliation: 1
- name: Mark S. Bandstra
affiliation: 1
- name: Brian Plimley
affiliation: 1
- name: Joseph C. Curtis
affiliation: 1
- name: Marco Salathe
affiliation: 1
- name: Chun Ho Chow
affiliation: 1
- name: Micah Folsom
affiliation: 1
- name: Tenzing H.Y. Joshi
jvavrek marked this conversation as resolved.
Show resolved Hide resolved
affiliation: 1
- name: Daniel Hellfeld
affiliation: 1
- name: J. Ali Hanks
affiliation: 2
affiliations:
- name: Applied Nuclear Physics group, Lawrence Berkeley National Laboratory
index: 1
- name: Department of Nuclear Engineering, University of California, Berkeley
index: 2
date: 04 Mar 2021
bibliography: paper.bib
---

# Summary

Nuclear spectroscopic analysis follows a typical workflow: collect binmode or listmode spectra of radiation detections, apply a calibration from detector observables to energy deposition, fit spectral peaks to determine the number of counts detected above background, and then relate changes in net counts to measurement parameters. While there are several open-source general scientific computing packages such as `ROOT` and `numpy` suitable for handling spectroscopic data, no dedicated solution exists for both managing and analyzing spectroscopic measurements, forcing students and researchers to develop their own codes independently (e.g., [@unzueta_gamma], [@sandia_interspec], [@morrell_curie]).

`becquerel` is a Python package for analyzing nuclear spectroscopic measurements that seeks to prevent this wide duplication of efforts. It provides open-source standard analysis tools, including peak finding and fitting, automated energy calibrations, spectrum rebinning, and file I/O across several widely-used formats in nuclear spectroscopy. Built atop the Python scientific stack of `numpy`, `scipy`, `pandas`, and `numba`, `becquerel` is fast, flexible, and easy to use given even an introductory knowledge of Python. In addition, `becquerel` provides a comprehensive test suite, coverage metrics, and several example notebooks for quickly getting started with various analyses. Finally, it also provides a convenient Python interface to the NIST XCOM [@xcom] and NNDC [@nndc] nuclear databases, eliminating the need for ad-hoc downloads or manual data entry.

`becquerel` was developed to be useable by a wide range of nuclear scientists and engineers, from undergraduates in laboratory courses to academic and national laboratory researchers. It has already been used to facilitate analyses in several works, including [@vavrek2020reconstructing], [@bandstra2020modeling], [@salathe2021determining], [@lamb2021cylindrical], and the Berkeley RadWatch project [@radwatch], and will facilitate the rapid development of future spectroscopic analyses and workflows.

# Acknowledgements
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should acknowledge:

  • PIs
  • lab IPO office
  • funding such as noted in the copyright notice

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@markbandstra How about something simple:
"We acknowledge funding support from the U.S. Department of Energy and Department of Defense, and licensing support from Berkeley Lab's Intellectual Property Office."
More detail can always be found in the disclosure if necessary. I don't know about thanking PIs—Tenzing is already on the author list, but I suppose we could mention Josh or others?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know, thinking of this document (paper.md) as a normal journal paper, it would be most appropriate to list any support by agency and grant number, even if it is available elsewhere. I think it would be a good gesture to ask Josh and anyone else if they want to be acknowledged.


We acknowledge funding support from the U.S. Department of Energy and Department of Defense, and licensing support from Berkeley Lab's Intellectual Property Office.

# References