papillon-ndl

Papillon Nuclear Data Library

https://github.com/hunterbelanger/papillon-ndl

Science Score: 67.0%

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

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.4%) to scientific vocabulary

Keywords

cpp montecarlo nuclear-engineering nuclear-power python
Last synced: 6 months ago · JSON representation ·

Repository

Papillon Nuclear Data Library

Basic Info
Statistics
  • Stars: 15
  • Watchers: 1
  • Forks: 7
  • Open Issues: 2
  • Releases: 4
Topics
cpp montecarlo nuclear-engineering nuclear-power python
Created over 5 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

Papillon Nuclear Data Library

CMake Workflow Documentation Status License DOI

The Papillon Nuclear Data Library (NDL) is a C++/Python library for reading, sampling, and interacting with continuous energy nuclear data, stored in the ACE nuclear data format.

For examples of how to use the library in both C++ and Python, take a look at the documentation site. That is where you will also be able to fined more detailed installation instructions.

License

PapillonNDL is provided under the terms and conditions of the GPLv3 license.

Dependencies

The library may be built on Unix-like operating systems or on Windows. All that is required is cmake >= 3.11, and a C++ compiler which supports the C++20 standard. For Unix-like systems, the recommended compilers are GCC >= 11 or Clang >= 15. On Windows, you should have MSVC >= 19.29. In order to build the Python interface, Python >= 3.5 should be installed on your system, in addition to the Python development libraries and header files.

Tests are not built by default, and should only be needed for developers. You can turn them on by using -DPNDL_TESTS=ON with cmake.

Install

To build PapillonNDL, navigate to the directory where you would like to keep the source files, and then run the following commands: $ git clone https://github.com/HunterBelanger/papillon-ndl.git $ cd papillon-ndl $ cmake -E make_directory build $ cd build $ cmake -DCMAKE_BUILD_TYPE=Release .. $ cmake --build . --target install

If you do NOT want to build the Python bindings for PapillonNDL, then you should add the flag -DPNDL_PYTHON=OFF to the cmake command.

Owner

  • Name: Hunter Belanger
  • Login: HunterBelanger
  • Kind: user

Computational Physicist. Nuclear Reactor Physicist.

Citation (CITATION.cff)

cff-version: 1.2.0
title: Papillon Nuclear Data Library
message: 'If you use this software, please cite it as below.'
type: software
authors:
  - family-names: Belanger
    given-names: Hunter
    orcid: 'https://orcid.org/0000-0001-7601-8686'
url: 'https://github.com/HunterBelanger/papillon-ndl'
license: GPL-3.0-or-later
doi: 10.5281/zenodo.7121174
preferred-citation:
  type: article
  authors:
    - family-names: Belanger
      given-names: Hunter
      orcid: 'https://orcid.org/0000-0001-7601-8686'
  doi: 10.1051/epjn/2023006
  journal: EPJ Nuclear Sciences & Technologies
  title: >-
    Papillon Nuclear Data Library – a free and open-source C++/Python library
    for interacting with ACE files for continuous-energy neutron data
  volume: 9
  year: 2023
  start: 1
  end: 23

GitHub Events

Total
  • Issues event: 1
  • Watch event: 4
  • Fork event: 1
Last Year
  • Issues event: 1
  • Watch event: 4
  • Fork event: 1

Committers

Last synced: over 1 year ago

All Time
  • Total Commits: 410
  • Total Committers: 2
  • Avg Commits per committer: 205.0
  • Development Distribution Score (DDS): 0.002
Past Year
  • Commits: 7
  • Committers: 2
  • Avg Commits per committer: 3.5
  • Development Distribution Score (DDS): 0.143
Top Committers
Name Email Commits
Hunter Belanger h****r@g****m 409
Kazuyoshi Furutaka f****a@j****p 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: over 1 year ago

All Time
  • Total issues: 9
  • Total pull requests: 22
  • Average time to close issues: 4 months
  • Average time to close pull requests: 3 days
  • Total issue authors: 1
  • Total pull request authors: 2
  • Average comments per issue: 0.22
  • Average comments per pull request: 0.41
  • Merged pull requests: 21
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: about 2 months
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 7.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • HunterBelanger (9)
  • 2018uch0002 (1)
Pull Request Authors
  • HunterBelanger (21)
  • furutaka (1)
Top Labels
Issue Labels
enhancement (3) bug (1) documentation (1)
Pull Request Labels

Dependencies

docs/requirements.txt pypi
  • Jinja2 <3.1
  • breathe >=4.20.0
  • jupyter *
  • nbsphinx >=0.7.1
  • sphinx ==3.2.1
.github/workflows/cmake.yml actions
  • actions/checkout v2 composite