-
Notifications
You must be signed in to change notification settings - Fork 4
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
Update to use OpenMC v0.14.0, update documentation #19
Merged
Merged
Changes from 75 commits
Commits
Show all changes
83 commits
Select commit
Hold shift + click to select a range
94ee041
update tests and streamline depletion functions
abachma2 3f3ebc9
update reading materials function from Depletion class
abachma2 2def7fe
add depletion results for testing suite
abachma2 c27af33
update comp to h5 committed to repo
abachma2 ef029ce
add unit test file
ceserz2 711cc54
comment out integration test
ceserz2 ff0d7a4
adding the rest of the steps to build the environment
ceserz2 8f0f272
adding "run tests" step
ceserz2 ed82f4d
adding "install numpy" step
ceserz2 23ac454
adding "install mamba from conda" step
ceserz2 2a96a4b
adding a new install command for mamba
ceserz2 71f9ec1
updating conda install for mamba
ceserz2 23847b4
adding "checking environment step"
ceserz2 158246b
commenting out "install mamba from conda" step
ceserz2 075eb92
adding "conda info" step
ceserz2 deb9107
adding "conda info" to steps
ceserz2 8ad3391
fixing "conda info" steps
ceserz2 b402679
updating environment setup
ceserz2 e79b3c7
fixing more errors with environment activation
ceserz2 e278951
removing environment activation step
ceserz2 fe212d8
fixing errors in setting up environment
ceserz2 fa131ec
updating environment command added
ceserz2 a551733
fixing "activate environment" function for each step
ceserz2 8e28507
more fixes on code
ceserz2 2b715e2
inserting "conda init" command to initialize shell
ceserz2 3feec33
fixing command to activate the environment
ceserz2 7b7cae9
trying a new method for environment activation
ceserz2 f283b3e
trying to update code to fix CI file
ceserz2 e7a8ccf
Merge branch 'ci' of github.com:ceserz2/openmcyclus_cz into tests
abachma2 53dc24c
add gitignore file
abachma2 caa46f4
add CHANGELOG for repo
abachma2 b52d2ab
add contributing guide
abachma2 5d079ff
run on PR only while making updates
abachma2 ed5dca2
adjsut list formatting
abachma2 32f5a33
adjsut formatting more
abachma2 42d8a14
add CONTRIBUTING to changelog
abachma2 de2d5b3
update dependency versions and some text
abachma2 1da2b2e
actually only run on PR not push
abachma2 4c5e1b8
fix syntax to run on PR
abachma2 e2effad
convert to rst, and change formatting
abachma2 7b3f738
correct cyclus website link
abachma2 df46ce4
fix formatting
abachma2 765bcd9
fix the rest of the format errors
abachma2 8c46594
Merge branch 'tests' into updates
abachma2 9489e16
set to run only on PR while actively working on updates
abachma2 f974a08
add note about deps on conda, may be used for install, unsure yet
abachma2 38f8b2f
start update for OpenMC 0.14.0
abachma2 9446845
remove file, no longer needed for testing
abachma2 33dbf59
remove file, not needed for testing
abachma2 f5b9380
add python script of OpenMC model for debugging
abachma2 a416d95
finish updating models to OpenMC 0.14.0
abachma2 8aa9c94
get mox model spent comp printed
abachma2 ee9f931
add flux parameter, refactor getting spent comps
abachma2 2801494
add test for run_depletion, update formats for others
abachma2 28f94c7
add scipy dep, modify description of openmc needs
abachma2 7a07bd6
change to run on push
abachma2 6564be1
remove duplicate steps, add scipy version
abachma2 fcb2227
correct format, add more file types
abachma2 f18292f
clean up unused steps
abachma2 1d49d96
add missing files for comparison, deplete unused file
abachma2 0e37e73
add thermal power input parameter
abachma2 94a4d1a
add flux parameter, update transmute
abachma2 87eb4f0
remove coversion factor parameter
316652c
remove instantializing self.micro_xs
abachma2 7652e6c
return transmute to using OpenMC, remove check_existing_recipes
abachma2 10f46e5
add new params, change spent uox to pu
abachma2 69a5ed1
remove Cycamore Reactor in lib specs
abachma2 9fe8dab
add new parameters
abachma2 4fccf04
update CHANGELOG
abachma2 0fa32d9
pep8 fixes
abachma2 6b432e7
add new params, update install instructions
abachma2 02b8637
correct code block format
abachma2 3bd9f4c
update deps install and code format for input
abachma2 9eae286
make some of the suggestions from @yardasol
abachma2 c1d7d27
initialize microxs and materials with class
abachma2 4cffc67
change material and microxs initialization
abachma2 de80f4b
pep8 fixes, update documentation
abachma2 c98667b
pep8 fixes
abachma2 f07eb28
change cyclus/cycamore install instructions
abachma2 96eb863
address comments from @yardasol
abachma2 1d1568a
fix test suite, function inputs and locations
abachma2 3aecd12
update OpenMC footnote
abachma2 34ab439
address docstring comments from @yardasol
abachma2 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
name: unit-tests | ||
on: [pull_request, push] | ||
|
||
jobs: | ||
build-and-unit-test: | ||
runs-on: ubuntu-latest | ||
defaults: | ||
run: | ||
shell: bash -el {0} | ||
|
||
steps: | ||
- uses: actions/checkout@v3 | ||
- name: Setup Conda | ||
uses: conda-incubator/setup-miniconda@v2 | ||
with: | ||
miniforge-variant: Mambaforge | ||
miniforge-version: latest | ||
activate-environment: openmcyclus-env | ||
environment-file: environment.yml | ||
use-mamba: true | ||
|
||
- name: Conda config | ||
run: | | ||
conda config --env --set pip_interop_enabled True | ||
|
||
- name: Install OpenMC from Mamba | ||
run: | ||
mamba install openmc scipy=1.11 | ||
|
||
- name: Install OpenMC cross section library | ||
run: | | ||
$GITHUB_WORKSPACE/openmc-xs.bash | ||
echo "OPENMC_CROSS_SECTIONS=cross_sections.xml" >> $GITHUB_ENV | ||
|
||
- name: Install OpenMCyclus | ||
run: | ||
pip install . | ||
|
||
- name: Run Tests | ||
run: | ||
pytest tests/unit_tests/test_depletion.py | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
__pycache__/ | ||
*.ipynb_checkpoints/ | ||
*.sqlite | ||
*.h5 | ||
|
abachma2 marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
====================== | ||
OpenMCyclus Change Log | ||
====================== | ||
|
||
Since last release: | ||
=================== | ||
|
||
**Added:** | ||
|
||
* Added `CHANGELOG.rst`, `.gitignore`, `CONTRIBUTING.rst`, | ||
and unit tests for `openmcyclus.Depletion` class. Also | ||
added files for better reproduction of comparison benchmar (#18) | ||
* Add input parameters to `DepleteReactor` for the thermal | ||
power (instead of just using `power_cap`) and flux | ||
(required input for running OpenMC with new version) (#18) | ||
|
||
**Changed:** | ||
|
||
* Change OpenMC dependency to v0.14.0, which includes adding | ||
parameters for using `DepleteReactor` (#18) | ||
|
||
**Removed:** | ||
|
||
* Remove `check_existing_recipes` method in `DepleteReactor` (#18) | ||
|
||
**Fixed:** | ||
|
||
|
||
v 0.1.0 | ||
========= | ||
Initial release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
*************************** | ||
Contributing to OpenMCyclus | ||
*************************** | ||
|
||
Welcome, and thank you for your interest in developing OpenMCyclus. This document | ||
serves as a guide for making contributions to this archetype library. | ||
|
||
General Notes | ||
============= | ||
OpenMCyclus relies on Cyclus and OpenMC, so familiarity with using both is | ||
recommended. Please refer to the `Cyclus website <http://fuelcycle.org>`_ and | ||
`OpenMC documenatation <https://docs.openmc.org/en/v0.14.0/index.html>`_ for | ||
information about each code. | ||
|
||
Contributions to this software are made via GitHub, so familiarity with | ||
git is recommended. Resources for installing | ||
and using git and GitHub include: | ||
|
||
* The `git website <https://git-scm.com/>`_ | ||
|
||
* The `GitHub docs <https://docs.github.com/en>`_ | ||
|
||
* This `tutorial <https://help.github.com/articles/using-pull-requests/>`_ on creating | ||
pull requests | ||
|
||
The general steps for contributing to OpenMCyclus are: | ||
|
||
1. Create a fork of the OpenMCyclus repository | ||
2. Create a new branch on your fork, keeping the `main` branch clean and | ||
up-to-date with the ARFC version of the repository `main` branch | ||
3. Make your desired changes on your new branch | ||
4. Make sure all of the tests pass. You can run the tests locally, or they will | ||
run in the CI (via GitHub Actions) when you push changes | ||
5. When you're finished with your changes and the tests pass, update the | ||
`CHANGELOG <CHANGELOG.rst>`_ with the changes you've made. | ||
6. Issue a pull request into the ARFC repository `main` branch. | ||
|
||
Reviewing pull requests | ||
======================= | ||
Reviewing pull requests is an important part of development work. When | ||
reviewing pull requests please: | ||
|
||
* Make sure the code is consistent with the `PEP 8 style guide <https://peps.python.org/pep-0008/>`_ | ||
* Make sure all tests in CI are passing | ||
* Ensure that new tests are added as needed to address new features | ||
* Make positive, constructive comments on the code | ||
abachma2 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Once all conversations are resolved and all tests pass, you are welcome to | ||
merge the pull request. | ||
|
||
Running tests: | ||
============== | ||
pytest is used for all tests. Tests should be run from the top-level | ||
directory of this repository using: | ||
|
||
.. code-block:: bash | ||
|
||
$ pytest tests/ | ||
|
||
Releases: | ||
========= | ||
When a new release is ready: | ||
|
||
#. Update all documentation as needed and issue a PR for this | ||
#. git tag -a <version> | ||
#. git push upstream main | ||
#. git push upstream <version> |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider bundling these changes into the existing
test-openmcyclus
workflow.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are you referring to the build process? Or the tests themselves? I was planning on streamlining the build process in a different PR so this one didn't get too big.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I do plan to have another PR later on for checking if the CHANGELOG is updated. I'm not sure if that's what you were referring to here.