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

Allow user to provide ocean resolution at setup_expt invocation #2204

Closed

Conversation

aerorahul
Copy link
Contributor

@aerorahul aerorahul commented Jan 8, 2024

Description

This PR:

  • allows a user to provide a desired ocean resolution during the invocation of setup_expt.py.
  • renames --resdet option to --resdetatmos
  • adds --resdetocean. If a value <= 0. is provided, the program will choose based on pre-selected options.
  • updates the CI test yamls
  • updates the documentation

Type of change

  • New feature (adds functionality)
  • Maintenance (code refactor)

Change characteristics

  • Is this a breaking change (a change in existing functionality)? No, but users will need to update their use of setup_expt.py
  • Does this change require a documentation update? YES

How has this been tested?

  • Created a few of the experiment directories using create_experiment.py and the various ci/cases yaml files and inspected config.base in the respective experiment directories.

Checklist

  • Any dependent changes have been merged and published
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings
  • New and existing tests pass with my changes
  • I have made corresponding changes to the documentation if necessary

@aerorahul aerorahul marked this pull request as ready for review January 9, 2024 17:40
Copy link
Member

@KateFriedman-NOAA KateFriedman-NOAA left a comment

Choose a reason for hiding this comment

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

Looks good! Left a few comments but approve pending any CI testing.

docs/doxygen/mainpage.h Outdated Show resolved Hide resolved
workflow/setup_expt.py Show resolved Hide resolved
@@ -521,13 +524,32 @@ def validate_user_request(host, inputs):
raise NotImplementedError(f"Supported resolutions on {machine} are:\n{', '.join(supp_res)}")


def get_ocean_resolution(resdetatmos):
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
def get_ocean_resolution(resdetatmos):
def get_default_ocean_resolution(resdetatmos):

docs/doxygen/mainpage.h Outdated Show resolved Hide resolved
KateFriedman-NOAA added a commit to KateFriedman-NOAA/global-workflow that referenced this pull request Jan 11, 2024
Merge remote-tracking branch 'upstream/feature/setup_expt_oceanres' into feature/clean_out_rotdir

* upstream/feature/setup_expt_oceanres:
  Update docs/doxygen/mainpage.h
  update default resdetocean
  update documentation instances of resdet and resens; add resdetocean
  update yamls for ci tests
  fix pynorm error
  add option to provide an ocean resolution during setup_expt.py
@aerorahul
Copy link
Contributor Author

Absorbed in #2204.
Closing.

@aerorahul aerorahul closed this Jan 12, 2024
@aerorahul aerorahul deleted the feature/setup_expt_oceanres branch January 12, 2024 15:54
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.

3 participants