Skip to content

Enhancement: Allow StatAnalysis to utilize timing information in file input selection #3234

@j-opatz

Description

@j-opatz

Describe the Enhancement

A recent Discussions question shed light on a limitation of the StatAnalysis tool. When using the MODEL<n>_STAT_ANALYSIS_LOOKIN_DIR setting, the tool selects all stat files that it finds in the provided directories.

That behavior limits what users can verify; specifically, a user who has more than the desired timeframe worth of stat files in a given directory cannot use a subset of the files based on time.

This enhancement would allow users to have the following setting, for example:

MODEL1_STAT_ANALYSIS_LOOKIN_DIR = /path/EnsembleStat/{init?fmt=%Y%m%d%H}

and StatAnalysis would use the configuration file's timing information to select only those stat files that fall within the user's begin and end times.

Time Estimate

Estimate the amount of work required here.
Issues should represent approximately 1 to 3 days of work.

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

  • Review default alert labels
  • Select component(s)
  • Select priority
  • Select requestor(s)

Milestone and Projects

  • Select Milestone as a METplus-Wrappers-X.Y.Z version, Consider for Next Release, or Backlog of Development Ideas
  • For a METplus-Wrappers-X.Y.Z version, select the METplus-Wrappers-X.Y.Z Development project

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.
  • For any new datasets, an entry to the METplus Verification Datasets Guide.
  • 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 issue
    Select: Milestone as the next official version
    Select: METplus-Wrappers-X.Y.Z Development project for development toward the next official release
  • 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

Status

🩺 Needs Triage

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions