Add project funding attribution

[durack1]

The DoE BER RGMA program has been funding CMOR development for decades, however, we don't point that out in this (and other relevant) repos.

It would be great to add this attribution to the README.md, along with a tasteful, small DOE logo. An example attribution is included https://github.com/PCMDI/pcmdi_metrics#acknowledgement (the contributors section above is also worth considering!) - I think this could be repeated across all repos, unless tweaks are suggested?

It'd be useful to do this blanket across many of the PCMDI project repos, e.g. https://github.com/cmecmetrics, https://github.com/PCMDI/pcmdi_metrics, https://github.com/PCMDI/pcmdi_metrics_results_archive, what else?

@acordonez @lee1043 @paullric @taylor13 @gleckler1 comments?

[durack1]

@mauzey1 apologies, I forgot to ping you on the above - but please chime in as the primary repo admin!

Whatever changes we make to this and other repos, should also find it's way into https://github.com/PCMDI/cmor3_documentation and the webpages generated by that repo

[durack1]

I might suggest the tweaked text below:

Acknowledgement
---------------

Software contained in this repository is developed by climate and computer scientists from the Program
for Climate Model Diagnosis and Intercomparison ([PCMDI][PCMDI]) at Lawrence Livermore National
Laboratory ([LLNL][LLNL]). This work is sponsored by the Regional and Global Model Analysis
([RGMA][RGMA]) program, of the Earth and Environmental Systems Sciences Division ([EESSD][EESSD])
in the Office of Biological and Environmental Research ([BER][BER]) within the
[Department of Energy][DOE]'s [Office of Science][OS]. The work is performed under the auspices of
the U.S. Department of Energy by Lawrence Livermore National Laboratory under Contract
DE-AC52-07NA27344.

[PCMDI]: https://pcmdi.llnl.gov/
[LLNL]: https://www.llnl.gov/
[RGMA]: https://climatemodeling.science.energy.gov/program/regional-global-model-analysis
[EESSD]: https://science.osti.gov/ber/Research/eessd
[BER]: https://science.osti.gov/ber
[DOE]: https://www.energy.gov/
[OS]: https://science.osti.gov/

DOE logos are available from https://powerpedia.energy.gov/wiki/DOE_Seal_and_Logo#DOE_Seal_and_Logo_Artwork

[durack1]

apologies @klein21 also pinging you on this thread

[durack1]

I also wonder whether there is a standard CLI blurb acknowledging PCMDI/RGMA/DOE the first time that PMP or CMEC is run? If yes, can that code be pointed to? @lee1043 @acordonez likely a question to you both

[lee1043]

@durack1 good idea. PMP repo has Acknowledgement statement in the first page (see here , but I'd be interested to have standard text across repos.

[klein21]

@durack1 Suggested language looks fine. Please check that all of the html links are current. I agree that it would be good to do this.

[mauzey1]

#692 (comment) This looks fine to me so I will add it to the README.

[durack1]

@mauzey1 great. I was also taking a peek around our repos to see what DOE assets/graphics we have. In CMEC (https://github.com/PCMDI/CMEC/tree/master/assets/images) we have a couple of assets, which we might want to reuse, or even centralize in a PCMDI "assets" or similar repo for reuse across elements?

[durack1]

@lee1043 just an FYI, I have managed to make a little progress in this space, and would suggest you update your text* to:

## Contributors

[![Contributors](https://contrib.rocks/image?repo=PCMDI/input4MIPs-cmor-tables)](https://github.com/PCMDI/input4MIPs-cmor-tables/graphs/contributors)

## Acknowledgement

Content in this repository is developed by climate and computer scientists from the Program for Climate Model Diagnosis and Intercomparison ([PCMDI][PCMDI]) at Lawrence Livermore National Laboratory ([LLNL][LLNL]). This work is sponsored by the Regional and Global Model Analysis ([RGMA][RGMA]) program, of the Earth and Environmental Systems Sciences Division ([EESSD][EESSD]) in the Office of Biological and Environmental Research ([BER][BER]) within the [Department of Energy][DOE]'s [Office of Science][OS]. The work is performed under the auspices of the U.S. Department of Energy by Lawrence Livermore National Laboratory under Contract DE-AC52-07NA27344.

<p>
    <img src="https://github.com/PCMDI/assets/blob/main/DOE/480px-DOE_Seal_Color.png?raw=true"
         width="65"
         style="margin-right: 30px"
         title="United States Department of Energy"
         alt="United States Department of Energy"
    >&nbsp;
    <img src="https://github.com/PCMDI/assets/blob/main/LLNL/212px-LLNLiconPMS286-WHITEBACKGROUND.png?raw=true"
         width="65"
         title="Lawrence Livermore National Laboratory"
         alt="Lawrence Livermore National Laboratory"
    >
</p>

*noting that repo reference updates are required, and the "Content in this repository.." should be "Software contained in this repository.." for the more software-centric repos

[lee1043]

@durack1 thank you for that. I updated following README pages using it!

• PMP
• PMP result archive

[durack1]

@mauzey1 would you mind updating the following repos with the above snippet?

• https://github.com/PCMDI/cmor
• https://github.com/PCMDI/pcmdi.github.io
• https://github.com/PCMDI/cmip6-cmor-tables
• https://github.com/PCMDI/cmor3_documentation

@lee1043 may as well add:

• https://github.com/PCMDI/PCMDI_Simulation_Summaries

Or should that repo be archived? We should probably rename the archived repos, if we use a | that is the last char in UTF-8 which will sort them at the end of the long repo list

[lee1043]

@durack1 Good point! I will add it to PCMDI_Simulation_Summaries repo too.

PCMDI_Simulation_Summaries repo is still in use although it is private repo. It is mostly for interactive graphic contents for the PMP results in the PCMDI website.

[acordonez]

@durack1 I've added the updated acknowledgement to the cmec-driver, autodataman, example cmec module, and cmec module manager repos. The images were not working for me.
The CMEC software doesn't have a blurb at runtime. It you have something short (eg, under 160 characters) I can add it to print at runtime for CMEC driver, but I think anything longer would degrade the user experience.

[durack1]

The images were not working for me.

@acordonez that's weird, I was able to use the images on https://github.com/WCRP-CMIP/CMIP6_CVs/#acknowledgement, which is outside the PCMDI org too, so not sure why that wasn't working for you. The blurb on the CVs page is a subtly tweaked version of the original.

The CMEC software doesn't have a blurb at runtime. It you have something short (eg, under 160 characters) I can add it to print at runtime for CMEC driver, but I think anything longer would degrade the user experience.

I have no template for this, we probably should have something. @lee1043 do you have something in the PMP as an example?

[lee1043]

I have no template for this, we probably should have something. @lee1043 do you have something in the PMP as an example?

I don't have one. Below is what I have for PMP's README, maybe condensed version of it could be used for CMEC runtime.

"Content in this repository is developed by climate and computer scientists from the Program for Climate Model Diagnosis and Intercomparison (PCMDI) at Lawrence Livermore National Laboratory (LLNL). This work is sponsored by the Regional and Global Model Analysis (RGMA) program, of the Earth and Environmental Systems Sciences Division (EESSD) in the Office of Biological and Environmental Research (BER) within the Department of Energy's Office of Science. The work is performed under the auspices of the U.S. Department of Energy by Lawrence Livermore National Laboratory under Contract DE-AC52-07NA27344."

For example (please feel free to revise):
"CMEC development is sponsored by the Department of Energy (DOE) Biological and Environmental Research (BER) Regional and Global Model Analysis program. This work is performed under the auspices of the U.S. Department of Energy by Lawrence Livermore National Laboratory under Contract DE-AC52-07NA27344."

[mauzey1]

@durack1 Since the CMOR repo's README already has the acknowledgement section, could we move or close this issue?

[acordonez]

@durack1 @lee1043 A multi-sentence attribution is going to seriously bloat the CMEC terminal output, and lead to bad user experience. Is there a reason something like a 1-line copyright statement would be insufficient, given that we have the attributions in the code READMEs?

[lee1043]

@acordonez agreed. As you have acknowledgement statements in README, I think 1-line (or even shorter or not having statement) should be fine in the terminal interface.

"CMEC is sponsored by DOE/BER/RGMA" or "coordinated by DOE and NOAA..." or something like that in simple should be fine. I think Paul U can help crafting the message.

@mauzey1 Yes, the discussion is extended beyond CMOR and I think @acordonez @durack1 and I can continue this discussion in CMEC repository (or wherever it applies) if needed. Please feel free to close this issue.

[durack1]

The images were not working for me.

@acordonez it turns out that the private setting on the PCMDI/assets repo was preventing image access to folks not part of the PCMDI organization - I didn't realize that until last night, when I converted the repo to public and it now works while I am not logged in, did you want to try again with the images?

[lee1043]

@durack1 That explains why it was working for me while it was not working for @acordonez. Thank you for discovering it.

[acordonez]

@durack1 Yes it looks like I can see the images now (eg https://github.com/cmecmetrics/cmec-driver#acknowledgement). Thanks Paul.

[durack1]

@acordonez great, private browser windows managed to uncover the issue for me! I am glad we're now working across all repos