NCAR / wrfcloud

WRF Cloud Framework
Apache License 2.0
15 stars 6 forks source link

Update UG with new feature documentation #220

Closed fossell closed 1 year ago

fossell commented 1 year ago

Describe the New Feature

UG needs a review and update reflecting new features:

Acceptance Testing

Build RTDs successfully.

Time Estimate

1 day.

Sub-Issues

Consider breaking the new feature down into sub-issues.

Relevant Deadlines

List relevant project deadlines here or state NONE.

Define the Metadata

Assignee

Labels

Projects and Milestone

New Feature Checklist

fossell commented 1 year ago

Merging issue #200 to this issue since it is documentating a new feature on the UI.

Per Issue https://github.com/NCAR/wrfcloud/issues/26 / PR https://github.com/NCAR/wrfcloud/pull/197, new error checking is enabled that displays failure messages to the UI. User guide needs to be updated to include description of these status messages. currently thinking this should be added to UG 4.4.1, with mention of next steps to advanced debugging by accessing full logs in S3 (currently described in UG 3.3).

Information from PR https://github.com/NCAR/wrfcloud/pull/197:

Failures from each process are caught and reported to UI. Status message displayed on UI for a failed job will include the process name, e.g. GeoGrid failed, if the process returned a non-zero error code, if none of the expected output files exist, or if the log file does not contain text that signifies a successful run. If something else goes wrong in the run logic, the status message will just say Failed.

Holding off on doing this right now in light of planned feature https://github.com/NCAR/wrfcloud/issues/198 to also display details of log files directly in the UI. With this development, documentation in UG will change or be added to.

fossell commented 1 year ago

Fixed with #227