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

API Zero-indexed universes on results reader #288

Merged

Conversation

drewejohnson
Copy link
Collaborator

Closes #277 by starting burnup steps at 0 rather than 1. Similarly, for cases where there is no burnup, the values of burnup and days are set as 0, rather than one.

The former case, zero-indexing, make the getUniv method and the storing of universes more pythonic, as arrays, lists, tuples, etc. start at position 0 in python. This is also consistent with the branching reader

univ = branch.addUniverse(unvID, burnup, burnupIndex - 1)

This is a breaking change, as the storage of universes has been changed, and thus

  • this is included in the next major release, 0.7.0
  • documentation has been updated to clearly indicate the change, both in the changelog and in the class docstring

This is a breaking change, as storage of homogenized universes
has changed. The first burnup index is now 0, not 1. This move
makes the universes zero-indexed, consistent with the python
ecosystem and the rest of this package.

Tests have been updated to reflect these changes. The initial value
of burnup and days for problems with out burnup are now zero,
rather than one.
@drewejohnson drewejohnson added documentation pythonicness API - Incompatible Incompatible changes to our API that require user actions labels Mar 5, 2019
@drewejohnson drewejohnson added this to the 0.7.0 milestone Mar 5, 2019
@drewejohnson drewejohnson merged commit 85f47bd into CORE-GATECH-GROUP:develop Mar 6, 2019
@drewejohnson drewejohnson added this to Review in Main Mar 6, 2019
@drewejohnson drewejohnson deleted the zero-ix-universes branch March 6, 2019 14:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API - Incompatible Incompatible changes to our API that require user actions documentation pythonicness
Projects
Main
Review
Development

Successfully merging this pull request may close these issues.

None yet

2 participants