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

Configure multistage settings #703

Merged
merged 11 commits into from
Jun 28, 2024
Merged

Conversation

mmutic
Copy link
Collaborator

@mmutic mmutic commented May 30, 2024

Description

This PR adds default settings for the multistage feature of GenX. It adds a file called configure_settings_multistage, and calls the function in that file in run_genx_multistage so that users no longer need to specify all multistage settings in order to run a multistage case.

What type of PR is this? (check all applicable)

  • Feature
  • Bug Fix

Related Tickets & Documents

This is related to Issue #658 but does not directly fix it (another PR will address that issue).

Checklist

  • Code changes are sufficiently documented; i.e. new functions contain docstrings and .md files under /docs/src have been updated if necessary.
  • The latest changes on the target branch have been incorporated, so that any conflicts are taken care of before merging. This can be accomplished either by merging in the target branch (e.g. 'git merge develop') or by rebasing on top of the target branch (e.g. 'git rebase develop'). Please do not hesitate to reach out to the GenX development team if you need help with this.
  • Code has been tested to ensure all functionality works as intended.
  • CHANGELOG.md has been updated (if this is a 'notable' change).
  • I consent to the release of this PR's code under the GNU General Public license.

How this can be tested

To test this, I deleted the multistage settings dictionary in example 6 (multistage) to see if GenX would still run successfully and it did. Note that the file still needs to be present, but does not need to have anything in it.

Post-approval checklist for GenX core developers

After the PR is approved

  • Check that the latest changes on the target branch are incorporated, either via merge or rebase
  • Remember to squash and merge if incorporating into develop

src/case_runners/case_runner.jl Outdated Show resolved Hide resolved
src/configure_settings/configure_settings_multistage.jl Outdated Show resolved Hide resolved
src/write_outputs/ucommit/write_commit.jl Outdated Show resolved Hide resolved
src/write_outputs/ucommit/write_commit.jl Outdated Show resolved Hide resolved
src/write_outputs/ucommit/write_shutdown.jl Outdated Show resolved Hide resolved
src/write_outputs/ucommit/write_shutdown.jl Outdated Show resolved Hide resolved
src/write_outputs/ucommit/write_start.jl Outdated Show resolved Hide resolved
src/configure_settings/configure_settings_multistage.jl Outdated Show resolved Hide resolved
src/write_outputs/ucommit/write_start.jl Outdated Show resolved Hide resolved
src/write_outputs/write_charge.jl Outdated Show resolved Hide resolved
src/write_outputs/write_charge.jl Outdated Show resolved Hide resolved
src/write_outputs/write_charge.jl Outdated Show resolved Hide resolved
src/write_outputs/write_reliability.jl Outdated Show resolved Hide resolved
src/write_outputs/write_storage.jl Outdated Show resolved Hide resolved
src/write_outputs/write_storage.jl Outdated Show resolved Hide resolved
src/write_outputs/write_storagedual.jl Outdated Show resolved Hide resolved
src/write_outputs/write_storagedual.jl Outdated Show resolved Hide resolved
@lbonaldo lbonaldo added this to the v0.4.1 milestone Jun 20, 2024
Repository owner deleted a comment from github-actions bot Jun 28, 2024
Repository owner deleted a comment from github-actions bot Jun 28, 2024
Repository owner deleted a comment from github-actions bot Jun 28, 2024
@lbonaldo lbonaldo force-pushed the configure_multistage_settings branch from 7f87782 to 8f48635 Compare June 28, 2024 23:02
Copy link
Collaborator

@lbonaldo lbonaldo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @mmutic!

@lbonaldo lbonaldo merged commit fea2877 into develop Jun 28, 2024
9 checks passed
@lbonaldo lbonaldo deleted the configure_multistage_settings branch June 28, 2024 23:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants