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

doc additions, docstring typo fixes, cross section processing scripts #90

Merged
merged 37 commits into from
Dec 17, 2021

Conversation

yardasol
Copy link
Contributor

@yardasol yardasol commented Dec 10, 2021

Summary of changes

This PR adds the following to doc/:

  • under installation.rst, a new section on cross section libraries
  • under installation.rst, a new section on testing

This PR also adds a script (and an accompanying README) that users can execute to download and process the JEFF 3.1.2 library automatically for the purposes of running the examples and integration tests.

This PR also fixes typos and omissions in the docstrings from #64.

Finally, this PR updates the package version of SaltProc to 0.3.0, and designates myself as the maintainer.

This PR should be merged before #87 so we can apply the changes to the generated docs.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Required for Merging

  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
    • CI tests pass
    • Local tests pass (including Serpent2 integration tests)

Associated Issues and PRs

Associated Developers

Checklist for Reviewers

Reviewers should use this link to get to the
Review Checklist before they begin their review.

@pep8speaks
Copy link
Contributor

pep8speaks commented Dec 10, 2021

Hello @yardasol! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

Line 465:1: E101 indentation contains mixed spaces and tabs
Line 465:1: W191 indentation contains tabs

Line 8:1: E265 block comment should start with '# '
Line 96:1: W391 blank line at end of file

Comment last updated at 2021-12-16 20:53:40 UTC

@yardasol yardasol changed the title doc additions, docstring typo fixes doc additions, docstring typo fixes, cross section processing scripts Dec 13, 2021
@yardasol
Copy link
Contributor Author

Figure produced by nulcides_mass.ipynb for TAP example using the JEFF library produced by process_j312.sh:
index

Figure produced by nulcides_mass.ipynb for TAP example using the JEFF library produced by Andrei:
index

Figure produced by burnup_plotter.ipynb for TAP example using the JEFF library produced by process_j312.sh:
index

Figure produced by burnup_plotter.ipynb for TAP example using the JEFF library produced by Andrei:
index

I'm not seeing much of a difference between these two cross section libraries. @andrewryh do the bugs in the JEFF 3.1.2 effect nuclides not covered in nuclides_mass.ipynb?

@yardasol yardasol marked this pull request as ready for review December 13, 2021 23:51
Copy link
Contributor

@abachma2 abachma2 left a comment

Choose a reason for hiding this comment

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

Overall, this looks good. A few comments that I think would improve readability and use of the scripts.

saltproc/depcode.py Outdated Show resolved Hide resolved
saltproc/depcode.py Outdated Show resolved Hide resolved
scripts/README.md Show resolved Hide resolved
@yardasol yardasol requested a review from abachma2 December 16, 2021 22:53
Copy link
Contributor

@abachma2 abachma2 left a comment

Choose a reason for hiding this comment

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

Looks good. Thanks for making those changes! I'll go ahead and merge this PR.

@abachma2 abachma2 merged commit ca9522c into arfc:master Dec 17, 2021
LukeSeifert added a commit that referenced this pull request Jan 10, 2022
Patch #90 (pep8 issues, docstring consistency)
@yardasol yardasol deleted the update-docs branch March 9, 2022 19:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants