-
Notifications
You must be signed in to change notification settings - Fork 11
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
Reorganize into multi-package monorepo #63
Closed
Closed
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
scdhulipala
reviewed
Dec 3, 2024
…rt rts_gmlc and toymodel in PRASFiles
sriharisundar
requested changes
Dec 5, 2024
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.
Can change some @assert
s in doc strings to maybe show sample outputs, but let's track that as an issue and take care of it later?
sriharisundar
approved these changes
Dec 5, 2024
Thanks all! Closing since this is now the default branch for the repo. |
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 splits out functionality into separate packages,
PRASCore
,PRASFiles
, andPRASCapacityCredits
, and sets the stage for moving additional packages into the repo as well (e.g.PRASAnalytics
).PRAS
is retained as a meta-package that automatically loads the other packages. Tests run on each package individually but coverage reporting is done repository-wide (https://app.codecov.io/gh/NREL/PRAS/tree/main).This simultaneously removes support for the
Convolution
simulation specification, and more generally removes the infrastructure for using simulation specifications other thanSequentialMonteCarlo
. This simplifies the existing codebase and also provides a more gradual transition path for users towards the Rust rewrite, which will only support chronological Monte Carlo simulation.Although no longer necessary, for backwards-compatibility the (system, simspec, resultspec) triple API is retained for assess calls, although
assess(sys, Convolution(), resultspecs...)
will no longer work.Given the above breaking changes, this also updates each package version to
0.7.0
, which can be the first version we submit to the General registry.I also pulled in @josephmckinsey's docstring commit and augmented it with dccf8d7.
I'm thinking we won't rebase this PR onto
master
, but rather just switch the repo default branch over to this one (main
) when we're ready. Anyone working with aPRAS#master
package install will stay onv0.6
.