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

Create new use case category "Clouds" and migrate 6 existing AQ and Comp use cases to new Clouds category #2221

Closed
22 tasks
j-opatz opened this issue Jun 20, 2023 · 2 comments · Fixed by #2237
Closed
22 tasks
Assignees
Labels
METplus: Air Quality and Composition priority: high High Priority reporting: DTC AF METplus Air Force METplus Project required: FOR OFFICIAL RELEASE Required to be completed in the official release for the assigned milestone type: task An actionable item of work
Milestone

Comments

@j-opatz
Copy link
Contributor

j-opatz commented Jun 20, 2023

Describe the Task

After guidance from the latest governance meeting, it was decided that the Air Force use cases looking at cloud characteristics currently residing in Air Quality and Composition would be relocated to a new use case category called Clouds. This will require

  • making a clouds directory in the repo
  • moving PANDA-C use-cases from AQ/Comp to Clouds
  • updating GHA to include new Clouds category
  • updating the documentation of the 6 use cases to reflect the new use case category

Time Estimate

~5 hours

Sub-Issues

Consider breaking the task down into sub-issues.

  • Add a checkbox for each sub-issue here.

Relevant Deadlines

List relevant project deadlines here or state NONE.

Funding Source

2771022

Define the Metadata

Assignee

  • Select engineer(s) or no engineer required
  • Select scientist(s) or no scientist required

Labels

  • Select component(s)
  • Select priority
  • Select requestor(s)

Projects and Milestone

  • Select Repository and/or Organization level Project(s) or add alert: NEED CYCLE ASSIGNMENT label
  • Select Milestone as the next official version or Future Versions

Define Related Issue(s)

Consider the impact to the other METplus components.

Task Checklist

See the METplus Workflow for details.

  • Complete the issue definition above, including the Time Estimate and Funding Source.
  • Fork this repository or create a branch of develop.
    Branch name: feature_<Issue Number>_<Description>
  • Complete the development and test your changes.
  • Add/update log messages for easier debugging.
  • Add/update unit tests.
  • Add/update documentation.
  • Add any new Python packages to the METplus Components Python Requirements table.
  • Push local changes to GitHub.
  • Submit a pull request to merge into develop.
    Pull request: feature <Issue Number> <Description>
  • Define the pull request metadata, as permissions allow.
    Select: Reviewer(s) and Development issues
    Select: Repository level development cycle Project for the next official release
    Select: Milestone as the next official version
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.
@j-opatz j-opatz added priority: high High Priority type: task An actionable item of work reporting: DTC AF METplus Air Force METplus Project required: FOR OFFICIAL RELEASE Required to be completed in the official release for the assigned milestone METplus: Air Quality and Composition labels Jun 20, 2023
@j-opatz j-opatz added this to the METplus-5.1.0 milestone Jun 20, 2023
@j-opatz j-opatz self-assigned this Jun 20, 2023
@j-opatz
Copy link
Contributor Author

j-opatz commented Jun 20, 2023

Currently there's an issue where none of the use cases are being run in the all use cases text file (since there is a full disk error for all of the use cases), but when setting up the test runs file for this category you have to run at least 1 of the use cases. I will need to figure out how to fix the full disc before submitting this branch for PR.

@j-opatz
Copy link
Contributor Author

j-opatz commented Jul 7, 2023

The issue described previously was (indirectly) solved with the use of CI overrides, #2237. Due to the large amounts of thresholds and neighborhood widths used in each PANDA-C use case, they would take 40+ minutes to run which is oftentimes too much memory and time for GitHub Actions (GHA) to handle. Through the use of the CI overrides configuration file, the thresholds were limited to two or 3, while also limiting which of the 3 GridStat instances was run for GHA in each use case. This significantly improved run times and allowed the successful migration of the use cases from Air Quality and Composition to Clouds.

There are three remaining tasks connected to this issue, even with the aforementioned PR resolving the primary need for this issue. The first is pictures for each of the use cases. While they can be dropped in quickly and will be ready to be displayed in ReadTheDocs, they still need to be identified.
The second issue is the placement of a new section within the Contributor's Guide that explains and lists those use cases currently utilizing CI override configuration files and how to create one if needed. If a contributor has reason to update an existing use case and that use case utilizes CI overrides, there needs to be additional guidance on how or if to update the CI override configuration file and that any GHA results are only a reflection of the CI override file and not necessarily the updates. Currently it's located in the Input Data chapter, but discussions with team members has suggested a better place for it may be a new section or chapter of Use Case Content.
The final issue is grouping of the use cases in the GHA list. Currently each use case is run as a separate group, which is no longer necessary given the quicker run times. To avoid unnecessary instance usage, some of these should be combined.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
METplus: Air Quality and Composition priority: high High Priority reporting: DTC AF METplus Air Force METplus Project required: FOR OFFICIAL RELEASE Required to be completed in the official release for the assigned milestone type: task An actionable item of work
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

2 participants