Renaming DOE to parameter sweep throughout#768
Draft
johnjasa wants to merge 2 commits into
Draft
Conversation
This file contains hidden or 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
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.
Rename
design_of_experimentstoparameter_sweepand improve docsRenames the
design_of_experimentsYAML key and all related references toparameter_sweepthroughout the codebase to avoid confusion with "Department of Energy" (DOE), which is frequently referenced in our domain.The core code in
pose_optimization.pysupports both the newparameter_sweepkey and the legacydesign_of_experimentskey for backward compatibility.Additional documentation improvements:
Originally suggested by James Niffenegger.
Section 1: Type of Contribution
Section 2: Draft PR Checklist
TODO:
design_of_experimentstoparameter_sweepin core Python code with backward compatibilityType of Reviewer Feedback Requested (on Draft PR)
Structural feedback:
Implementation feedback:
Other feedback:
Section 3: General PR Checklist
docs/files are up-to-date, or added when necessaryCHANGELOG.md"A complete thought. [PR XYZ]((https://github.com/NatLabRockies/H2Integrate/pull/XYZ)", where
XYZshould be replaced with the actual number.Section 4: Related Issues
User feedback that "DOE" as an acronym is confusing with "Department of Energy" in the energy systems domain.
Section 5: Impacted Areas of the Software
Section 5.1: New Files
docs/user_guide/parameter_sweep_in_h2i.mddesign_of_experiments_in_h2i.mdwith updated terminology, generator descriptions, and improved formatting.Section 5.2: Modified Files
Anywhere we had design of experiments listed explicitly has parameter sweep now.
Some examples still say "doe", which I think is fine, but let me know if you disagree!
Section 6: Additional Supporting Information
The legacy
design_of_experimentsYAML key is still supported for backward compatibility. Existing configs will continue to work without changes, but new configs should useparameter_sweep.