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

Update the documentation for the ens, NEP, and NMEP configuration options #2513

Closed
6 of 20 tasks
JohnHalleyGotway opened this issue Apr 18, 2023 · 2 comments
Closed
6 of 20 tasks
Assignees
Labels
component: documentation Documentation issue priority: high High Priority requestor: UK Met Office United Kingdom Met Office type: task An actionable item of work
Milestone

Comments

@JohnHalleyGotway
Copy link
Collaborator

Describe the Task

In dtcenter/METplus#2125, @RogerHar notes that NEP and NMEP appear in the documentation for both Gen-Ens-Prod section 9.2.1 and Ensemble-Stat section 5.3.1. The entire ens dictionary was removed from Ensemble-Stat in MET version 11.0.0 but more documentation updates are needed to clarify this. Sections 5.3.1.1, 5.3.1.2, and 5.3.1.3 should be deleted, but only after confirming that the content has been properly migrated to the Gen-Ens-Prod chapter.

Time Estimate

4 hours?

Sub-Issues

Consider breaking the task down into sub-issues.
None needed.

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.

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.
  • 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.
@JohnHalleyGotway JohnHalleyGotway added component: documentation Documentation issue type: task An actionable item of work requestor: UK Met Office United Kingdom Met Office alert: NEED ACCOUNT KEY Need to assign an account key to this issue priority: high High Priority labels Apr 18, 2023
@JohnHalleyGotway JohnHalleyGotway added this to the MET 11.1.0 milestone Apr 18, 2023
@JohnHalleyGotway JohnHalleyGotway moved this from 📋 Backlog to 🔖 Ready in MET-11.1.0 Development Apr 18, 2023
@j-opatz
Copy link
Contributor

j-opatz commented May 12, 2023

After review, it looks like an update is only needed to correct the configuration file name in Sect 5.3.1.1 through 5.3.1.3. It currently lists those subsections as part of Ensemble-Stat, when they should be Gen-Ens-Prod. So a simple update to 5.3.1 to be Gen-Ens-Prod, followed by the creation of a new 5.3.2 section for Ensemble-Stat, should work. The following subsections (5.3.1.4+) are correctly listed as Ensemble-Stat and should be placed under the new 5.3.2 section.

No information will need to be deleted during this migration.

@j-opatz
Copy link
Contributor

j-opatz commented May 15, 2023

Documentation was updated as described, with an additional move of the ensemble_flag dictionary to be included in the new GenEnsProd configuration section.

@j-opatz j-opatz closed this as completed May 15, 2023
@github-project-automation github-project-automation bot moved this from 🔖 Ready to ✅ Done in MET-11.1.0 Development May 15, 2023
@JohnHalleyGotway JohnHalleyGotway changed the title Clean up ens, NEP, and NMEP documentation Update the documentation of the ens, NEP, and NMEP configuration options Jun 13, 2023
@JohnHalleyGotway JohnHalleyGotway changed the title Update the documentation of the ens, NEP, and NMEP configuration options Update the documentation for the ens, NEP, and NMEP configuration options Jun 13, 2023
@JohnHalleyGotway JohnHalleyGotway removed the alert: NEED ACCOUNT KEY Need to assign an account key to this issue label Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Documentation issue priority: high High Priority requestor: UK Met Office United Kingdom Met Office type: task An actionable item of work
Projects
No open projects
Status: Done
Development

No branches or pull requests

2 participants