FRIDGe

FRIDGe: Fast Reactor Input Deck Generator - Published in JOSS (2019)

https://github.com/ryanstwrt/fridge

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
    1 of 2 committers (50.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software
Last synced: 6 months ago · JSON representation

Repository

This repository is for the Fast Reactor Input Deck Generator (FRIDGe)

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

README.md

Build Status Coverage Status License status

FRIDGe

Fast Reactor Input Deck Generator is a general purpose fast reactor MCNP input deck creator. Currently FRIDGe has the ability to create two different types of assemblies; fuel and smear. These assemblies can the be arranged to create a full reactor core model. The input file gives the user the ability to set the temperature, cross-section set, and MCNP variables for a given problem.

Documentation

Documentation can be found Here. This documentation holds all of the information to build elements, materials, assemblies, cores, and FRIDGe input files. FRIDGe comes packaged with 24 elements, 8 materials, 2 assemblies, and 1 FRIDGe input file pre-built. Along with this there are 3 test assemblies, 1 test core, and 4 test FRIDGe input files that can be used as a template for building these files.

Install

To download FRIDGe, change into your directory of choice and follow the instructions below:

bash git clone https://github.com/ryanstwrt/FRIDGe

Note that FRIDGe requires at least Python 3.6 to run. Before installing FRIDGe note that pytest, numpy, and PyYAML are all required to run FRIDGe. If these are not yet installed run the following:

bash pip install -r requirements.txt

This will ensure that all the dependencies are properly installed. To install FRIDGe, run the setup.py file in the /FRIDGe directory as follows:

bash python setup.py install

This should install fridge as a python package.

Testing

It is encouraged to run the test suite built into FRIDGe before creating any models. Testing FRIDGe is relatively simple. Open a terminal in the /fridge directory and run the following:

bash python -m pytest

Note: pytest, numpy, and PyYAML are all required to run FRIDGe, and the test suite. See the testing section of the user pages for more information.

Running FRIDGe

FRIDGe has a prebuilt input file which can be used to gain familiarity with running FRIDGe. The FRIDGe input file that will be used is title EBRII_Driver.yaml, and is uses the assembly file EBRII_MKII.yaml. These two YAML files can be found in /fridge/fridge_input_files and /fridge/data/assembly, respectively.

The first step is to open an interactive python terminal (somethign like iPython). From here, import the FRIDGe driver with the following: bash import fridge.driver.fridge_driver as fd The driver for FRIDGe has now been imported, and the main function can be run via: bash fd.main(''<fridge_input_file>'') For this example the following code can be run: bash fd.main('EBRII_Driver') This will cause FRIDGe to build an MCNP input file in /fridge/mcnp_input_files titled EBRII_Driver.i. This example built a single assembly; the process for running FRIDGe and building a full core model is identical.

Development

As FRIDGe is open source, I encourage anyone who is interested to contribute and add to the code. There are multiple phenomena that could be incorporated into FRIDGe to produce a more realistic model.

Contact

Please feel free to email me at stewryan@oregonstate.edu if you have any questions or if you would like me to consider additional features.

Owner

  • Name: Ryan Stewart
  • Login: ryanstwrt
  • Kind: user

JOSS Publication

FRIDGe: Fast Reactor Input Deck Generator
Published
August 07, 2019
Volume 4, Issue 40, Page 1486
Authors
Ryan H. Stewart
Oregon State University, 1500 SW Jefferson St. Corvallis, OR 97331
Editor
Kathryn Huff ORCID
Tags
nuclear engineering reactor design fast reactor

GitHub Events

Total
Last Year

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 334
  • Total Committers: 2
  • Avg Commits per committer: 167.0
  • Development Distribution Score (DDS): 0.003
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
ryanstwrt s****n@i****u 333
Patrick Shriwise p****e@g****m 1
Committer Domains (Top 20 + Academic)
isu.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 3
  • Total pull requests: 2
  • Average time to close issues: 13 days
  • Average time to close pull requests: 7 days
  • Total issue authors: 2
  • Total pull request authors: 2
  • Average comments per issue: 4.33
  • Average comments per pull request: 1.0
  • Merged pull requests: 2
  • 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
  • kellyrowland (2)
  • pshriwise (1)
Pull Request Authors
  • pshriwise (1)
  • ryanstwrt (1)
Top Labels
Issue Labels
Pull Request Labels