Add documentation for the Parallel Manager #1220
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1220 +/- ##
=======================================
Coverage 94.78% 94.78%
=======================================
Files 353 353
Lines 35454 35454
=======================================
Hits 33604 33604
Misses 1850 1850 ☔ View full report in Codecov by Sentry. |
bknueven
approved these changes
Nov 28, 2023
adam-a-a
reviewed
Nov 29, 2023
adam-a-a
reviewed
Nov 29, 2023
Comment on lines
+103
to
+104
| documentation. A lot of features are currently missing from the parallel | ||
| manager that limits its wider use. We encourage developers to make PRs to the |
There was a problem hiding this comment.
Are there some immediate examples that come to mind that we should list somewhere, e.g., in an issue?
There was a problem hiding this comment.
We have all the necessary features needed to run the parameter sweep. If however, we wanted to make the parallel manager into a standalone package we would need features that, for example, allows one worker to send data to another and so on. I do not think we need to make an issue for it quite yet as this is only tangentially related to WaterTAP.
adam-a-a
reviewed
Nov 29, 2023
Co-authored-by: Adam Atia <aatia@keylogic.com>
avdudchenko
approved these changes
Nov 29, 2023
adam-a-a
approved these changes
Dec 4, 2023
lbianchi-lbl
pushed a commit
to watertap-org/parameter-sweep
that referenced
this pull request
May 1, 2024
* added some parallel manager documentation to watertap. * update docs to render correctly. * update documentation to remove redundant documentation. * Grammatical fix Co-authored-by: Adam Atia <aatia@keylogic.com> * add more context around which parallel paradigm to use for analysis. --------- Co-authored-by: Kinshuk <kinshuk.panda@nrel.gov> Co-authored-by: Adam Atia <aatia@keylogic.com>
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.
Fixes/Resolves:
Addresses #1195 by adding documentation for the parallel manager
Summary/Motivation:
Meet the project goals
Changes proposed in this PR:
Legal Acknowledgement
By contributing to this software project, I agree to the following terms and conditions for my contribution: