pyrk

Python for Reactor Kinetics

https://github.com/pyrk/pyrk

Science Score: 41.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
○
DOI references
○
Academic publication links
✓
Committers with academic emails
1 of 8 committers (12.5%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (15.5%) to scientific vocabulary

Last synced: 6 months ago · JSON representation ·

Repository

Python for Reactor Kinetics

Basic Info

Host: GitHub
Owner: pyrk
Language: Python
Default Branch: master
Size: 4.05 MB

Statistics

Stars: 31
Watchers: 4
Forks: 32
Open Issues: 24
Releases: 0

Created almost 11 years ago · Last pushed 10 months ago

Metadata Files

Readme Changelog Contributing License Citation

PyRK

Welcome to PyRK. This is a solver tool for coupled neutronic and thermal hydraulic reactor transient analysis in 0-D. It is in active development. Please correspond directly with the author for suggestions about use, additional documentation, etc.

Installation

Detailed instructions will be present in the upcoming user's guide. However, for now, install this as you would any other pure python module

python setup.py install

If you use --prefix, be sure to add the path to your PYTHONPATH environment variable.

Documentation

The documentation for pyrk can be found at pyrk.github.io. Additionally, the entire contents of that website can be built from the doc directory in the source code using the following steps

pip install sphinx
pip install sphinx_rtd_theme.
sphinx-apidoc --separate --force --output-dir=src/ ../pyrk
make clean
make html

After these steps, the website will be found in pyrk/doc/_build/html.

Getting Help

If you have a problem, please do not email the developers. Please create a GitHub issue here: . In that issue, please incude all information relevant to the problem. The issue should, at the very least, explain what you did, what you were expecting, and what you observed instead. We will need this information to reproduce your issue and help you debug it. Consider including the commands that you ran, the input files you used, the output hdf5 database that you used, and the exact text of any errors you encountered.

License

The license for this work can be found here. Please be respectful of my intellectual work by communicating with me about its use, understanding its limitations, and citing me where appropriate. I would be thrilled to work with you on improving it.

Contribution

This repository is a work in progress. I would love it if you wanted to contribute to this code here in this repository. Here is some information about how to do that..

Other

You will find the current state of the test suite on our Travis continuous integration servers.

Owner

Name: PyRK
Login: pyrk
Kind: organization
Location: University of California Berkeley

Repositories: 3
Profile: https://github.com/pyrk

This organization conducts reactor kinetics analyses.

Citation (CITATION.md)

## Citations

The information below should help you to properly cite PyRK where appropriate.
Up-to-date citations will be added as they are produced. 

### Software Citation

If you use the PyRK software, we ask that you cite the version of PyRK that you 
used::


#### Version 0.2
```tex

@article{huff_pyrk_2015-2,
author = "Kathryn Huff, Xin Wang",
title = "{PyRK v0.2}",
year = "2015",
month = "12",
publisher = "Figshare",
url = "http://dx.doi.org/10.6084/m9.figshare.2009058"
}
```

#### Version 0.1:

```tex

@article{huff_pyrk_2015,
author = "Kathryn Huff",
title = "{PyRK v0.1}",
year = "2015",
month = "09",
publisher = "Figshare",
url = "http://dx.doi.org/10.6084/m9.figshare.1540727"
}
```
If you use any of our published results or methods, please also cite the
relevant paper(s) below.  


### Method and Results Citations
 
   The SFR results should be cited :

```tex
@InProceedings{ kathryn_huff-proc-scipy-2015,
author    = { {K}athryn {H}uff },
title     = { {P}y{R}{K}: {A} {P}ython {P}ackage {F}or {N}uclear {R}eactor {K}inetics },
booktitle = { {P}roceedings of the 14th {P}ython in {S}cience {C}onference },
pages     = { 87 - 93 },
year      = { 2015 },
editor    = { {K}athryn {H}uff and {J}ames {B}ergstra }
}
```

   PB-FHR results should be cited :

```tex
@InProceedings{wang_sensitivity_2016,
        address = {San Francisco, CA},
        title = {A {Sensitivity} {Study} of a {Coupled} {Kinetis} and {Thermal}-{Hydraulics} {Model} for {Fluoride}-{Salt}-{Cooled}, {High}-{Temperature} {Reactor} ({FHR}) {Transient} {Analysis}},
        url = {icapp.ans.org},
        booktitle = {Proceedings of {ICAPP} 2016},
        publisher = {International Congress on Advances in Nuclear Power Plants},
        author = {Wang, Xin and Huff, Kathryn D. and Aufiero, Manuele and Peterson, Per F. and Fratoni, Massimiliano},
        month = apr,
        year = {2016},
        pages = {Paper 16555}
}
```

GitHub Events

Total

Issues event: 12
Watch event: 2
Issue comment event: 11
Push event: 1
Pull request review event: 2
Pull request review comment event: 1
Pull request event: 10
Fork event: 3

Last Year

Issues event: 12
Watch event: 2
Issue comment event: 11
Push event: 1
Pull request review event: 2
Pull request review comment event: 1
Pull request event: 10
Fork event: 3

Committers

Last synced: about 2 years ago

All Time

Total Commits: 571
Total Committers: 8
Avg Commits per committer: 71.375
Development Distribution Score (DDS): 0.308

Past Year

Commits: 0
Committers: 0
Avg Commits per committer: 0.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
Katy Huff	k**f@g**m	395
Xin Wang	i**n@g**m	151
Grant Bremer	g**r@g**m	15
Samuel Dotson	s**2@i**u	4
andrewryh	a**h@g**m	3
SungmoonJoo	s**n@S**l	1
Xin Wang	x**0@l**c	1
Katy Huff	k****f	1

Committer Domains (Top 20 + Academic)

ln000.brc: 1 illinois.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 53
Total pull requests: 49
Average time to close issues: over 1 year
Average time to close pull requests: about 1 month
Total issue authors: 17
Total pull request authors: 10
Average comments per issue: 2.4
Average comments per pull request: 2.49
Merged pull requests: 34
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 8
Pull requests: 7
Average time to close issues: N/A
Average time to close pull requests: 9 days
Issue authors: 4
Pull request authors: 2
Average comments per issue: 0.0
Average comments per pull request: 0.71
Merged pull requests: 1
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

katyhuff (13)
gbremer (11)
samgdotson (6)
xwa9860 (5)
mdisi2 (5)
ElijahCapps (2)
SterlingButters (1)
BwL1289 (1)
JBM-4949 (1)
ayinurazizah844 (1)
scaysbri (1)
edward-duchnowski (1)
andrewryh (1)
stattikbrock (1)
jordifradera (1)

Pull Request Authors

gbremer (15)
katyhuff (14)
mdisi2 (6)
xwa9860 (5)
ElijahCapps (3)
samgdotson (3)
KennellyT (2)
yardasol (1)
joosm (1)
andrewryh (1)

Top Labels

Issue Labels

enhancement (8) bug (6) help wanted (2) question (1)

Pull Request Labels

enhancement (8) bug (3)

Dependencies

requirements.txt pypi

bokeh *
matplotlib *
numpy *
pint *
scipy *
tables *

.github/workflows/on_push.yml actions

actions/checkout v4 composite
actions/setup-python v3 composite

setup.py pypi

pyrk

Science Score: 41.0%

Repository

Basic Info

Statistics

Metadata Files

README.md

PyRK

Installation

Documentation

Getting Help

License

Contribution

Other

Owner

Citation (CITATION.md)

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

Dependencies