Update EAMxx docs and improve help formatters #3044

jgfouca · 2024-10-17T23:12:38Z

No description provided.

github-actions · 2024-10-17T23:14:12Z

PR Preview Action v1.4.8
🚀 Deployed preview to https://E3SM-Project.github.io/scream/pr-preview/pr-3044/
on branch `gh-pages` at 2024-10-18 15:39 UTC

E3SM-Autotester · 2024-10-17T23:41:41Z

Status Flag 'Pull Request AutoTester' - Testing Jenkins Projects:

Pull Request Auto Testing STARTING (click to expand)

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

Build Information

Test Name: SCREAM_PullRequest_Autotester_Mappy

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

Using Repos:

Repo: SCREAM (E3SM-Project/scream)

Pull Request Author: jgfouca

E3SM-Autotester · 2024-10-17T23:42:04Z

Status Flag 'Pull Request AutoTester' - Jenkins Testing: all Jobs PASSED

Pull Request Auto Testing has PASSED (click to expand)

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

Build Information

Test Name: SCREAM_PullRequest_Autotester_Mappy

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

E3SM-Autotester · 2024-10-17T23:42:20Z

Status Flag 'Pre-Merge Inspection' - - This Pull Request Requires Inspection... The code must be inspected by a member of the Team before Testing/Merging
NO REVIEWS HAVE BEEN PERFORMED ON THIS PULL REQUEST!

E3SM-Autotester · 2024-10-17T23:42:27Z

All Jobs Finished; status = PASSED, target_sha=890d5d7778f8882628c67cf05f406bd859c0c0b4, However Inspection must be performed before merge can occur...

bartgol

Looks good. I have one suggestion for the test-all docs, but I'm going to approve anyways. You decide whether to do that mod or not. I removed automerge in case you want to do it.

I like the format of good formatter.

bartgol · 2024-10-18T14:19:16Z

components/eamxx/docs/developer/standalone_testing.md

+% ./scripts/test-all-scream -h
+```
+
+If you are unsure of the cmake configuration for you development cycle, one


We could mention the --config-only flag, rather than ctrl-C.

We should also mention that they may have to run eval $(./scripts/scream-env-cmd $mach) before running make in the build folder...

We could mention the --config-only flag, rather than ctrl-C.

I forgot about this option. I just tried it and unfortunately you still have to wait over a minute:

real 1m20.001s

I will make note of the need to load the scream env.

Ah, cause it has to actually run cmake, while with ctrl-C you kill it after it shows the cmake line. That makes sense.

That said, we often need to build/run just one exec. For that, we need to eventually run cmake anyways, so we should advertise the --config-only option, I think.

bartgol · 2024-10-18T14:20:27Z

components/eamxx/docs/developer/standalone_testing.md

+  tests rely on pre-existing baselines. The -b option controls the baseline
+  location and can have the following values:
+  * AUTO: A common public baseline area shared by all developers
+  * LOCAL: A private baseline area for the current developer in the current repo


Side question: what do you think about removing this? I don't think we ever use this feature, and it's just more code to maintain and code path to test in the scripts... The user can simply use -b ~/temp and be done.

I think it's a nice little convenience option. I looked and it's literally 3 lines of code to support:

local_baseline_dir = self._work_dir/"baselines" if self._baseline_dir == "LOCAL": self._baseline_dir = local_baseline_dir

E3SM-Autotester · 2024-10-18T16:26:02Z

Status Flag 'Pull Request AutoTester' - Testing Jenkins Projects:

Pull Request Auto Testing STARTING (click to expand)

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

Build Information

Test Name: SCREAM_PullRequest_Autotester_Mappy

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

Using Repos:

Repo: SCREAM (E3SM-Project/scream)

Pull Request Author: jgfouca

E3SM-Autotester · 2024-10-18T16:26:26Z

Status Flag 'Pull Request AutoTester' - Jenkins Testing: all Jobs PASSED

Pull Request Auto Testing has PASSED (click to expand)

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

Build Information

Test Name: SCREAM_PullRequest_Autotester_Mappy

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

E3SM-Autotester · 2024-10-18T16:26:43Z

Status Flag 'Pre-Merge Inspection' - - This Pull Request Requires Inspection... The code must be inspected by a member of the Team before Testing/Merging
THE LAST COMMIT TO THIS PULL REQUEST HAS NOT BEEN REVIEWED YET!

E3SM-Autotester · 2024-10-18T16:26:50Z

All Jobs Finished; status = PASSED, target_sha=624e53c81ea2d950f8520e33a209e14cbba0fec1, However Inspection must be performed before merge can occur...

bartgol

Looks good. I would maybe plan for another iteration, where we cover more power-user things, like --config-only, or the -l flag in combination with stuff in ~/.cime, to allow development on your own laptop/workstation.

But this is covering the basics, so we should merge.

E3SM-Autotester · 2024-10-18T19:14:53Z

The base branch has been updated since the last successful testing.

last PASS base branch sha: 624e53c
current base branch sha : 0fb8150
The AutoTester will discard the last PASS, and re-test the PR from scratch

E3SM-Autotester · 2024-10-18T19:14:56Z

Status Flag 'Pull Request AutoTester' - Testing Jenkins Projects:

Pull Request Auto Testing STARTING (click to expand)

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

Build Information

Test Name: SCREAM_PullRequest_Autotester_Mappy

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

Using Repos:

Repo: SCREAM (E3SM-Project/scream)

Pull Request Author: jgfouca

E3SM-Autotester · 2024-10-18T19:15:19Z

Status Flag 'Pull Request AutoTester' - Jenkins Testing: all Jobs PASSED

Pull Request Auto Testing has PASSED (click to expand)

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

Build Information

Test Name: SCREAM_PullRequest_Autotester_Mappy

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

Update EAMxx docs and improve help formatters

8eef1aa

jgfouca added the AT: AUTOMERGE Inform the autotester (AT) that it can merge this PR if reviewers approved, and tests pass label Oct 17, 2024

jgfouca requested review from bartgol and tcclevenger October 17, 2024 23:12

jgfouca added the AT: Integrate Without Testing label Oct 17, 2024

bartgol reviewed Oct 18, 2024

View reviewed changes

bartgol previously approved these changes Oct 18, 2024

View reviewed changes

bartgol removed the AT: AUTOMERGE Inform the autotester (AT) that it can merge this PR if reviewers approved, and tests pass label Oct 18, 2024

Remind devs to load scream env

29fdc0d

jgfouca dismissed bartgol’s stale review via 29fdc0d October 18, 2024 15:38

jgfouca added the AT: AUTOMERGE Inform the autotester (AT) that it can merge this PR if reviewers approved, and tests pass label Oct 18, 2024

jgfouca requested a review from bartgol October 18, 2024 15:38

bartgol approved these changes Oct 18, 2024

View reviewed changes

E3SM-Autotester merged commit d782bf0 into master Oct 18, 2024
7 checks passed

E3SM-Autotester removed the AT: AUTOMERGE Inform the autotester (AT) that it can merge this PR if reviewers approved, and tests pass label Oct 18, 2024

E3SM-Autotester deleted the jgfouca/update_eamxx_testing_docs branch October 18, 2024 19:15

Update EAMxx docs and improve help formatters #3044

Update EAMxx docs and improve help formatters #3044

Conversation

jgfouca commented Oct 17, 2024

github-actions bot commented Oct 17, 2024 • edited Loading

E3SM-Autotester commented Oct 17, 2024

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Jenkins Parameters

Build Information

Test Name: SCREAM_PullRequest_Autotester_Mappy

Jenkins Parameters

Using Repos:

E3SM-Autotester commented Oct 17, 2024

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Jenkins Parameters

Build Information

Test Name: SCREAM_PullRequest_Autotester_Mappy

Jenkins Parameters

E3SM-Autotester commented Oct 17, 2024

E3SM-Autotester commented Oct 17, 2024

bartgol left a comment • edited Loading

Choose a reason for hiding this comment

bartgol Oct 18, 2024

Choose a reason for hiding this comment

bartgol Oct 18, 2024

Choose a reason for hiding this comment

jgfouca Oct 18, 2024

Choose a reason for hiding this comment

bartgol Oct 18, 2024

Choose a reason for hiding this comment

bartgol Oct 18, 2024

Choose a reason for hiding this comment

jgfouca Oct 18, 2024

Choose a reason for hiding this comment

E3SM-Autotester commented Oct 18, 2024

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Jenkins Parameters

Build Information

Test Name: SCREAM_PullRequest_Autotester_Mappy

Jenkins Parameters

Using Repos:

E3SM-Autotester commented Oct 18, 2024

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Jenkins Parameters

Build Information

Test Name: SCREAM_PullRequest_Autotester_Mappy

Jenkins Parameters

E3SM-Autotester commented Oct 18, 2024

E3SM-Autotester commented Oct 18, 2024

bartgol left a comment

Choose a reason for hiding this comment

E3SM-Autotester commented Oct 18, 2024

E3SM-Autotester commented Oct 18, 2024

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Jenkins Parameters

Build Information

Test Name: SCREAM_PullRequest_Autotester_Mappy

Jenkins Parameters

Using Repos:

E3SM-Autotester commented Oct 18, 2024

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Jenkins Parameters

Build Information

Test Name: SCREAM_PullRequest_Autotester_Mappy

Jenkins Parameters

github-actions bot commented Oct 17, 2024 •

edited

Loading

bartgol left a comment •

edited

Loading