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

Add original scripts #47

Merged
merged 1 commit into from
Sep 30, 2024
Merged

Add original scripts #47

merged 1 commit into from
Sep 30, 2024

Conversation

forsyth2
Copy link
Collaborator

@forsyth2 forsyth2 commented Sep 13, 2024

Add original scripts, if reproduction scripts are unavailable.

@forsyth2
Copy link
Collaborator Author

@mccoy20 suggested that if we don't have reproduction scripts available, in their place we should include the original scripts on https://docs.e3sm.org/e3sm_data_docs/_build/html/v2/WaterCycle/reproducing_simulations/reproduction_table.html. I've begun that implementation here, but I don't think it's ideal. 3 issues:

  1. The checksum cell is also empty in this case, so there are still blank cells that remain.
  2. Adding "Original script:" before original scripts makes the table look sort-of clunky. I'd almost rather have a separate column for original scripts. (If we did something less intrusive, like an asterisk, then I fear users would miss the corresponding note the scripts are not reproduction scripts).
  3. Some simulations don't even have original scripts in the repo.

@mccoy20 @golaz How do we want to handle the above issues? Notably:

  • Should original run scripts even be added in the first place? I thought the point was that we don't want to be directing people to the original run scripts. Or would it be sufficient to add a note that users will have to do a great deal of manual modifications to get such a script working?
  • Is it better to have one column for scripts (reproduction, if missing then use original) or two columns (reproduction, original)?
  • Should the checksums be recorded for each simulation, regardless if there's a reproduction script?

@forsyth2 forsyth2 marked this pull request as ready for review September 24, 2024 00:31
@forsyth2
Copy link
Collaborator Author

@mccoy20 @golaz @chengzhuzhang I'd like to get approval from at least one of you before merging, to make sure the table looks as we want it to.

Here's a piece of what this will look like:
Screenshot 2024-09-23 at 5 39 43 PM

The entire table is currently displayed at https://portal.nersc.gov/cfs/e3sm/forsyth/data_docs/html/v2/WaterCycle/reproducing_simulations/reproduction_table.html

Things to note:

  • I moved the checksum column earlier and put the original script column at the end, since most people won't be going to the original script.
  • I know the script columns are overly wide, but that appears to be a limitation of the rst table formatting, which Use csv table #30 may fix:
        # TODO: The script boxes have to be 200 characters wide to fit in the links...
        # This is unfortunate because the actual displayed text is quite short.

I wasn't able to get any new information (e.g., checksums or original scripts) from reviewing https://acme-climate.atlassian.net/wiki/spaces/ED/pages/2766340117/V2+Simulation+Planning.

No checksums, reproduction scripts, or original scripts:

  • All LR > SSP370 LE simulations
  • All LR > Other simulations
  • All NARRM > Other simulations

No checksums or reproduction scripts; original scripts are present:

  • All LR > Historical LE simulations
  • v2.NARRM.historical_{0151, 0201, 0251, 0101_bonus}
  • v2.NARRM.amip_0101_bonus

No reproduction scripts; checksums and original scripts are present:

  • v2.LR.historical_0101_bonus
  • v2.LR.amip_0101_bonus

@forsyth2
Copy link
Collaborator Author

@mccoy20 approves of the current display view.

@forsyth2 forsyth2 merged commit d038fb8 into main Sep 30, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant