Skip to content

Remove LOOP_ORDER config variable #1687

@georgemccabe

Description

@georgemccabe

Discussion #1278 contains some information about this change.

There are a variety of benefits from removing this functionality, including more consistent behavior, more flexibility for configuring the wrappers, easier maintenance/room for enhancement of the existing code, and easier implementation of new wrappers.

Describe the Enhancement

  • Modify the config parsing logic to ignore the LOOP_ORDER variable and always execute the behavior for LOOP_ORDER=processes
  • Update default behavior for wrappers that behave differently based on the LOOP_ORDER value to preserve existing functionality (TCPairs, StatAnalysis, etc.)
  • Ensure all existing use cases still work as expected
  • Update documentation to note LOOP_ORDER is deprecated
  • Modify all wrappers to inherit from RuntimeFreqWrapper and set default runtime frequency that is appropriate for each wrapper (consider implementing multiple inheritance of wrapper classes to isolate runtime frequency/time looping class functions -- this would allow wrappers that support MET config files to also inherit from a class that contains the functions needed for that)

Time Estimate

2-5 days?

Sub-Issues

Consider breaking the enhancement down into sub-issues.

  • Add a checkbox for each sub-issue here.

Relevant Deadlines

List relevant project deadlines here or state NONE.

Funding Source

Define the source of funding and account keys here or state NONE.

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 PROJECT ASSIGNMENT label
  • Select Milestone as the next official version or Future Versions

Define Related Issue(s)

Consider the impact to the other METplus components.

Enhancement 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 Linked 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.

Metadata

Metadata

Assignees

Type

No type

Projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions