move rad calls docs from tech to user, update nudging and aerocom docs #2796

mahf708 · 2024-04-24T15:48:54Z

A slight reorg in docs added in earlier PRs, with more concrete and current examples. The rad calls docs was moved from technical to user.

github-actions · 2024-04-24T15:50:13Z

PR Preview Action v1.4.7
🚀 Deployed preview to https://E3SM-Project.github.io/scream/pr-preview/pr-2796/
on branch `gh-pages` at 2024-05-01 05:44 UTC

components/eamxx/docs/user/aerocom_cldtop.md

E3SM-Autotester · 2024-04-24T16:11:41Z

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

Pull Request Auto Testing STARTING (click to expand)

Build Information

Test Name: SCREAM_PullRequest_Autotester_Mappy

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

Using Repos:

Repo: SCREAM (E3SM-Project/scream)

Pull Request Author: mahf708

E3SM-Autotester · 2024-04-24T16:12:05Z

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_Mappy

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

E3SM-Autotester · 2024-04-24T16:12:21Z

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-04-24T16:12:28Z

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

mahf708 · 2024-04-24T16:22:34Z

@PeterCaldwell @bartgol let me know if you prefer things to be organized differently or updated differently. I have long thought placing the clear-clean-sky docs in technical was a poor decision (on my part) and so I wanted to move it to be user-facing. I also updated a few other things:

current example for nudging (taken out of my run scripts actually)
current example for the clear-clean-sky calls (also taken out of my run scripts)
I changed "AeroCOM" to "AeroCom" (apparently the latter branding is what they prefer, but the rest of Fortran code has the AeroCOM branding...) and added a technical report as an additional reference

mahf708 · 2024-04-24T16:54:44Z

Removing automerge to give @PeterCaldwell a chance to review/respond :)

components/eamxx/docs/technical/aerocom_cldtop.md

components/eamxx/docs/user/clean_clear_sky.md

components/eamxx/docs/user/coarse_nudging.md

E3SM-Autotester · 2024-04-24T18:00:12Z

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

Pull Request Auto Testing STARTING (click to expand)

Build Information

Test Name: SCREAM_PullRequest_Autotester_Mappy

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

Using Repos:

Repo: SCREAM (E3SM-Project/scream)

Pull Request Author: mahf708

E3SM-Autotester · 2024-04-24T18:00:36Z

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_Mappy

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

E3SM-Autotester · 2024-04-24T18:00:53Z

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-04-24T18:01:00Z

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

E3SM-Autotester · 2024-04-29T18:03:53Z

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

Pull Request Auto Testing STARTING (click to expand)

Build Information

Test Name: SCREAM_PullRequest_Autotester_Mappy

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

Using Repos:

Repo: SCREAM (E3SM-Project/scream)

Pull Request Author: mahf708

E3SM-Autotester · 2024-04-29T18:04: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_Mappy

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

E3SM-Autotester · 2024-04-29T18:04:36Z

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-04-29T18:04:43Z

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

E3SM-Autotester · 2024-04-30T03:40:45Z

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 BEEN REVIEWED, BUT NOT ACCEPTED OR REQUIRES CHANGES!

E3SM-Autotester · 2024-04-30T03:40:52Z

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

E3SM-Autotester · 2024-04-30T16:16:25Z

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

last PASS base branch sha: 0dc389b
current base branch sha : 305bde7
The AutoTester will discard the last PASS, and re-test the PR from scratch

E3SM-Autotester · 2024-04-30T16:16:28Z

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

Pull Request Auto Testing STARTING (click to expand)

Build Information

Test Name: SCREAM_PullRequest_Autotester_Mappy

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

Using Repos:

Repo: SCREAM (E3SM-Project/scream)

Pull Request Author: mahf708

E3SM-Autotester · 2024-04-30T16:16:54Z

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_Mappy

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

E3SM-Autotester · 2024-04-30T16:17:12Z

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

E3SM-Autotester · 2024-04-30T18:30:19Z

Status Flag 'Pull Request AutoTester' - AutoMerge IS ENABLED, but the Label AT: AUTOMERGE is not set. Either set Label AT: AUTOMERGE or manually merge the PR...

E3SM-Autotester · 2024-05-01T05:56:23Z

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

Pull Request Auto Testing STARTING (click to expand)

Build Information

Test Name: SCREAM_PullRequest_Autotester_Mappy

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

Using Repos:

Repo: SCREAM (E3SM-Project/scream)

Pull Request Author: mahf708

E3SM-Autotester · 2024-05-01T05:56:49Z

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_Mappy

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Build Num: -1
Status: SKIPPED

Jenkins Parameters

Parameter Name	Value

E3SM-Autotester · 2024-05-01T05:57:06Z

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-05-01T05:57:13Z

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

mahf708 · 2024-05-01T15:50:16Z

@PeterCaldwell, this was merged before you had a chance to review. Please let me know if you want edits to the nudging and/or any other docs. As our spirit goes, this is a live and evolving model and so are its docs! (I am also selfishly curious to hear your thoughts about the bib stuff, especially if you don't like how it is done now, so that we can attempt to improve it)

PeterCaldwell · 2024-05-01T15:51:22Z

Oh, I thought I did review it. In any case, I'm happy with it.

mahf708 · 2024-05-01T15:53:15Z

Oh, I thought I did review it. In any case, I'm happy with it.

oops, I meant a rereview after I addressed the comments. Good to know! Let us know if we can improve further :)

mahf708 added the AT: Integrate Without Testing label Apr 24, 2024

mahf708 requested review from bartgol and PeterCaldwell April 24, 2024 15:58

mahf708 changed the title ~~move rad calls docs from tech to user, minor fixes elsewhere~~ move rad calls docs from tech to user, update nudging and other docs Apr 24, 2024

PeterCaldwell reviewed Apr 24, 2024

View reviewed changes

components/eamxx/docs/user/aerocom_cldtop.md Outdated Show resolved Hide resolved

move rad calls from tech to user, update nudging and aerocom docs

b25a0e1

mahf708 force-pushed the mahf708/docs/updates branch from cab7a6f to b25a0e1 Compare April 24, 2024 16:05

mahf708 added the documentation label Apr 24, 2024

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

mahf708 changed the title ~~move rad calls docs from tech to user, update nudging and other docs~~ move rad calls docs from tech to user, update nudging and aerocom docs Apr 24, 2024

bartgol previously approved these changes Apr 24, 2024

View reviewed changes

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

PeterCaldwell reviewed Apr 24, 2024

View reviewed changes

components/eamxx/docs/technical/aerocom_cldtop.md Outdated Show resolved Hide resolved

PeterCaldwell reviewed Apr 24, 2024

View reviewed changes

components/eamxx/docs/user/clean_clear_sky.md Outdated Show resolved Hide resolved

PeterCaldwell reviewed Apr 24, 2024

View reviewed changes

components/eamxx/docs/user/clean_clear_sky.md Show resolved Hide resolved

PeterCaldwell reviewed Apr 24, 2024

View reviewed changes

components/eamxx/docs/user/coarse_nudging.md Outdated Show resolved Hide resolved

PeterCaldwell reviewed Apr 24, 2024

View reviewed changes

components/eamxx/docs/user/coarse_nudging.md Outdated Show resolved Hide resolved

refine and refocus the rad diags text

d1d8e3f

mahf708 dismissed bartgol’s stale review via d1d8e3f April 24, 2024 17:59

cleaned up nudging.md text

ed8859a

bartgol previously approved these changes Apr 30, 2024

View reviewed changes

update nudging docs + fix bibtex

a3d251d

mahf708 dismissed bartgol’s stale review via a3d251d May 1, 2024 05:29

updates to get bibtex working correctly

7a53ecc

mahf708 requested review from bartgol and PeterCaldwell May 1, 2024 05:47

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

bartgol approved these changes May 1, 2024

View reviewed changes

E3SM-Autotester merged commit 1951e1e into master May 1, 2024
9 checks passed

E3SM-Autotester deleted the mahf708/docs/updates branch May 1, 2024 15:11

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

move rad calls docs from tech to user, update nudging and aerocom docs #2796

move rad calls docs from tech to user, update nudging and aerocom docs #2796

Conversation

mahf708 commented Apr 24, 2024 • edited Loading

github-actions bot commented Apr 24, 2024 • edited Loading

E3SM-Autotester commented Apr 24, 2024

Build Information

Test Name: SCREAM_PullRequest_Autotester_Mappy

Jenkins Parameters

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Jenkins Parameters

Using Repos:

E3SM-Autotester commented Apr 24, 2024

Build Information

Test Name: SCREAM_PullRequest_Autotester_Mappy

Jenkins Parameters

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Jenkins Parameters

E3SM-Autotester commented Apr 24, 2024

E3SM-Autotester commented Apr 24, 2024

mahf708 commented Apr 24, 2024

mahf708 commented Apr 24, 2024

E3SM-Autotester commented Apr 24, 2024

Build Information

Test Name: SCREAM_PullRequest_Autotester_Mappy

Jenkins Parameters

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Jenkins Parameters

Using Repos:

E3SM-Autotester commented Apr 24, 2024

Build Information

Test Name: SCREAM_PullRequest_Autotester_Mappy

Jenkins Parameters

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Jenkins Parameters

E3SM-Autotester commented Apr 24, 2024

E3SM-Autotester commented Apr 24, 2024

E3SM-Autotester commented Apr 29, 2024

Build Information

Test Name: SCREAM_PullRequest_Autotester_Mappy

Jenkins Parameters

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Jenkins Parameters

Using Repos:

E3SM-Autotester commented Apr 29, 2024

Build Information

Test Name: SCREAM_PullRequest_Autotester_Mappy

Jenkins Parameters

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Jenkins Parameters

E3SM-Autotester commented Apr 29, 2024

E3SM-Autotester commented Apr 29, 2024

E3SM-Autotester commented Apr 30, 2024

E3SM-Autotester commented Apr 30, 2024

E3SM-Autotester commented Apr 30, 2024

E3SM-Autotester commented Apr 30, 2024

Build Information

Test Name: SCREAM_PullRequest_Autotester_Mappy

Jenkins Parameters

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Jenkins Parameters

Using Repos:

E3SM-Autotester commented Apr 30, 2024

Build Information

Test Name: SCREAM_PullRequest_Autotester_Mappy

Jenkins Parameters

Build Information

Test Name: SCREAM_PullRequest_Autotester_Weaver

Jenkins Parameters

E3SM-Autotester commented Apr 30, 2024

E3SM-Autotester commented Apr 30, 2024

E3SM-Autotester commented May 1, 2024

Build Information

mahf708 commented Apr 24, 2024 •

edited

Loading

github-actions bot commented Apr 24, 2024 •

edited

Loading