DEV New data model and proposal for 0.10.0 #400
Merged
Conversation
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
- Updated numpydoc page - Use a fake example so that it doesn't have to be updated - Fix some bad links and references
Will be introducing new recommendations for the next big phase of development
Spread across 0.11.0 [deprecate] and 0.12.0 [remove]
DanKotlyar
approved these changes
Apr 27, 2020
13 tasks
drewejohnson
added a commit
to drewejohnson/serpent-tools
that referenced
this pull request
May 23, 2020
Backport of features included since 0.9.3 release Includes the following PRs git log --online --pretty="%s" --merges 0.9.3... Merge pull request CORE-GATECH-GROUP#407 from drewejohnson/fix-readme Merge pull request CORE-GATECH-GROUP#406 from drewejohnson/r0.9.3 Merge pull request CORE-GATECH-GROUP#405 from nicoloabrate/master Merge pull request CORE-GATECH-GROUP#404 from drewejohnson/update-git-attr Merge pull request CORE-GATECH-GROUP#402 from drewejohnson/xsplot-labels Merge pull request CORE-GATECH-GROUP#400 from drewejohnson/lib2-notes Merge pull request CORE-GATECH-GROUP#399 from CORE-GATECH-GROUP/docs-sphinx-2.0 Merge pull request CORE-GATECH-GROUP#397 from drewejohnson/port-list-of-arrays Merge pull request CORE-GATECH-GROUP#398 from drewejohnson/det-supers Merge pull request CORE-GATECH-GROUP#396 from drewejohnson/df-arg-renaming Merge pull request CORE-GATECH-GROUP#394 from drewejohnson/0.9.3-update-docs Merge pull request CORE-GATECH-GROUP#395 from drewejohnson/hist-branch-dictlike Merge pull request CORE-GATECH-GROUP#393 from drewejohnson/less-metadata Merge pull request CORE-GATECH-GROUP#392 from drewejohnson/better-access Merge pull request CORE-GATECH-GROUP#391 from drewejohnson/dep-dataframe Merge pull request CORE-GATECH-GROUP#390 from drewejohnson/api-dep-attributes Merge pull request CORE-GATECH-GROUP#388 from drewejohnson/xsplot-branch Merge pull request CORE-GATECH-GROUP#378 from drewejohnson/better-build Merge pull request CORE-GATECH-GROUP#376 from drewejohnson/unbundle-data-files Merge pull request CORE-GATECH-GROUP#370 from drewejohnson/results-loa Merge pull request CORE-GATECH-GROUP#369 from drewejohnson/merge-0.9.1-develop
2 tasks
drewejohnson
added a commit
to drewejohnson/serpent-tools
that referenced
this pull request
Aug 31, 2020
Interface outside of the rc object for expanding variable groups. Abstracted away because the setting interface will eventually be removed (GH CORE-GATECH-GROUP#339) as each reader (built from CORE-GATECH-GROUP#335 and CORE-GATECH-GROUP#400) will control their own settings.
drewejohnson
added a commit
to drewejohnson/serpent-tools
that referenced
this pull request
Aug 31, 2020
Interface outside of the rc object for expanding variable groups. Abstracted away because the setting interface will eventually be removed (GH CORE-GATECH-GROUP#339) as each reader (built from CORE-GATECH-GROUP#335 and CORE-GATECH-GROUP#400) will control their own settings.
drewejohnson
added a commit
to drewejohnson/serpent-tools
that referenced
this pull request
Aug 31, 2020
Interface outside of the rc object for expanding variable groups. Abstracted away because the setting interface will eventually be removed (GH CORE-GATECH-GROUP#339) as each reader (built from CORE-GATECH-GROUP#335 and CORE-GATECH-GROUP#400) will control their own settings.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR introduces a new data model and guidelines for a major overhaul of the package. The goal of these changes are
The ease of
serpentTools.read, plotting, and filtering will not be disrupted in this period.To summarize, I propose the following.
serpentTools.next[name up for discussion] module on the develop branchserpentTools.nextserpentTools.nextmodule into the main API, with warnings that importing fromserpentTools.nextis discouragedserpentTools.nextWhy
Main benefits I see for this approach come primarily from comments made in #335. By separating the readers from the objects that store file data, we
There are lot of other benefits and more reasoning in the updated
docs/develop/datamodel.rstfile.Discussion
I intend on leaving this up for about a week or more, and alerting users through the mailing list about this change. Any comments or suggestions will be greatly appreciated, and also to let users know that there may be some bumps transitioning between new versions.
The goal is to make this change as smooth as possible, nearly transparent for basic
serpentTools.readprocessing. The main gains, but also changes, will be experienced by people who useserpentToolslike a library.I will update this PR message with a link to our sub-section in the Serpent forum for additional discussion.Forum post: https://ttuki.vtt.fi/serpent/viewtopic.php?f=30&t=3388#p10633