From b91eb73d8c3f35205d30a89c94af0f2cb25ed207 Mon Sep 17 00:00:00 2001 From: Robert Jacob Date: Tue, 28 Sep 2021 14:15:31 -0500 Subject: [PATCH 1/7] Update LICENSE Update paths to seperable components and mention new ones. --- LICENSE | 30 +++++++++++++++++++----------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/LICENSE b/LICENSE index 43912888398b..66727824b3ee 100644 --- a/LICENSE +++ b/LICENSE @@ -2,7 +2,7 @@ Except for the separable pieces descibed below, E3SM is released under the following 3-Clause BSD Open Source license. ******************************************************************************* -Copyright © 2018, UChicago Argonne, LLC All Rights Reserved +Copyright ©2021, UChicago Argonne, LLC All Rights Reserved Software Name: Energy Exascale Earth System Model (E3SM) @@ -41,7 +41,7 @@ CESM is public domain software. ******************************************************************************* -Separable Pieces with their own copyright and license: +Separable pieces with their own copyright and license: Name Code Location Institution(s) License ------------------------------------------------------------------------------- @@ -49,31 +49,39 @@ Name Code Location Institution(s) License Software ----------- CIME cime/ NCAR, SNL, ANL BSD -MCT cime/src/externals/mct ANL BSD -GPTL cime/src/share/timing author non-commerical +GPTL share/timing author non-commerical +MCT externals/mct ANL BSD +YAKL externals/YAKL author BSD +cub externals/cub NVIDIA BSD-like +kokkos externals/kokkos NTESS, LLC BSD Ocean/Ice under components/ ----------- ----------------- CICE cice LANL BSD +MPAS Framework mpas-framework LANL BSD MPAS Ocean mpas-ocean LANL BSD MPAS SeaIce mpas-seaice LANL BSD MPAS-Albany LandIce mpas-albany-landice LANL,SNL BSD -Land under components/clm/src +Land under components/elm/src ----------- ------------------------ Fates external_models/fates LBNL, NCAR, LANL BSD Betr external_models/betr LBNL BSD MPP external_models/mpp LBNL BSD -Atmosphere under components/cam/src +Atmosphere under components/eam/src ----------- ------------------------ CLUBB physics/clubb authors -- rrtmg physics/rrtmg AER non-commercial -COSP physics/cosp BCC BSD -Cosp/MISR physics/cosp/MISR_simulator author BSD -Cosp/LIDAR physics/cosp/actsim CNRS BSD -Cosp/quickbeam physics/cosp/quickbeam author BSD -Cosp/MODIS physics/cosp/MODIS_simulator U Colo. BSD +rrtmgp physics/rrtmgp/external AER non-commercial +COSP2 physics/cosp2 authors BSD +Cosp2/MISR physics/cosp2/external/src/simulator/MISR_simulator author BSD +Cosp2/MODIS physics/cosp2/external/src/simulator/MODIS_simulator U Colo. BSD +Cosp2/actsim physics/cosp2/external/src/simulator/actsim CRNS BSD +Cosp2/icarus physics/cosp2/external/src/simulator/icarus LLNL BSD +Cosp2/parasol physics/cosp2/external/src/simulator/parasol CRNS BSD +Cosp2/quikbeam physics/cosp2/external/src/simulator/quickbeam U Colo. BSD +Cosp2/rrtov physics/cosp2/external/src/simulator/rrtov U Colo. BSD icarus-scops physics/icarus-scops BCC BSD HOMMEXX components/homme/src/share/cxx SNL BSD components/homme/src/share/cxx/COPYRIGHT From b5428d97d03e130568fef05756c6147acc79b586 Mon Sep 17 00:00:00 2001 From: Robert Jacob Date: Tue, 28 Sep 2021 14:37:17 -0500 Subject: [PATCH 2/7] A few updates to CONTRIBUTING A few minor wording updates to CONTRIBUTING --- CONTRIBUTING.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d1e8732edddc..74a672a517b9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,7 +5,7 @@ * Is it a bug in E3SM code? E3SM includes several codes that are developed externally. See [LICENSE](LICENSE) for -locations and report your bug in the original developers site. +locations and, if appropriate, report your bug in the original developers site. * Ensure the bug was not already reported by searching on our GitHub instance under [Issues](https://github.com/E3SM-Project/E3SM/issues). @@ -17,6 +17,8 @@ version. #### **Do you want to fix an existing bug?** +* Thank you! + * Before you start writing code, please read [Developing E3SM](http://e3sm.org/model/running-e3sm/developing-e3sm/) to know more about our development workflow. @@ -29,7 +31,8 @@ the relevant issue number if applicable. #### **Did you fix whitespace, format code, or make a purely cosmetic patch?** Changes that are cosmetic in nature and do not add anything substantial to the -stability, functionality, or testability of E3SM will generally not be accepted. +stability, functionality, or testability of E3SM will generally not be accepted +from non-staff. #### **Do you intend to add a new feature or change an existing one?** From b7559c6affc6e291a04a121dfdc3c2c3c38f55e5 Mon Sep 17 00:00:00 2001 From: Robert Jacob Date: Tue, 28 Sep 2021 14:38:17 -0500 Subject: [PATCH 3/7] Update README for v2 Update the README using the reserved DOI for v2. Also point to Confluence documentation and github discussions. --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 69c6b7d4d7bb..8a68fd8e3d88 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,12 @@ the most challenging and demanding climate-change research problems and Department of Energy mission needs while efficiently using DOE Leadership Computing Facilities. -DOI: [10.11578/E3SM/dc.20180418.36](http://dx.doi.org/10.11578/E3SM/dc.20180418.36) +DOI: [10.11578/E3SM/dc.20210927.1](http://dx.doi.org/10.11578/E3SM/dc.20210927.1) -Please visit the [project website](https://e3sm.org) for further details. +Please visit the [project website](https://e3sm.org) or our [Confluence site](https://acme-climate.atlassian.net/wiki/spaces/DOC/overview) +for further details. + +For questions about the model, use [Github Discussions](https://github.com/E3SM-Project/E3SM/discussions) Table of Contents -------------------------------------------------------------------------------- @@ -61,16 +64,16 @@ the following BibTeX entry is provided. author = {{E3SM Project}}, abstractNote = {{E3SM} is a state-of-the-art fully coupled model of the {E}arth's climate including important biogeochemical and cryospheric processes.}, - howpublished = {[Computer Software] \url{https://dx.doi.org/10.11578/E3SM/dc.20180418.36}}, - url = {https://dx.doi.org/10.11578/E3SM/dc.20180418.36}, - doi = {10.11578/E3SM/dc.20180418.36}, - year = 2018, - month = apr, + howpublished = {[Computer Software] \url{https://dx.doi.org/10.11578/E3SM/dc.20210927.1}}, + url = {https://dx.doi.org/10.11578/E3SM/dc.20210927.1}, + doi = {10.11578/E3SM/dc.20210927.1}, + year = 2021, + month = sep, } ``` License -------------------------------------------------------------------------------- -The E3SM model became open development at the time of first model and data release. +The E3SM model is available under a BSD 3-clause license. Please see [LICENSE](LICENSE) for details. From af31a9c13704c0ca9ba1e1ef59b3289d47d95b0a Mon Sep 17 00:00:00 2001 From: Robert Jacob Date: Tue, 28 Sep 2021 16:58:50 -0500 Subject: [PATCH 4/7] Few more README fixes Few more README fixes --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8a68fd8e3d88..62d6e4739ebd 100644 --- a/README.md +++ b/README.md @@ -29,12 +29,12 @@ Quick Start -------------------------------------------------------------------------------- The [Quick Start](https://e3sm.org/model/running-e3sm/e3sm-quick-start/) page includes instructions on obtaining the necessary code and input data for model -setup and execution. +setup and execution on a supported machine. Supported Machines -------------------------------------------------------------------------------- -E3SM is high-performance computing application and generally requires a cluster -with several hundred nodes to run a scientifically validated case at a useful +E3SM is a high-performance computing application and generally requires a cluster +with a few dozen nodes to run a scientifically validated case at a useful simulation speed. To run E3SM, it is recommended that you obtain time on a From a4386dcb390cb21e8cf54759261007d54dcecd07 Mon Sep 17 00:00:00 2001 From: Robert Jacob Date: Tue, 28 Sep 2021 19:04:18 -0500 Subject: [PATCH 5/7] Fix a few more words on README Fix a few more words on README --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 62d6e4739ebd..7443e985e0b9 100644 --- a/README.md +++ b/README.md @@ -33,8 +33,8 @@ setup and execution on a supported machine. Supported Machines -------------------------------------------------------------------------------- -E3SM is a high-performance computing application and generally requires a cluster -with a few dozen nodes to run a scientifically validated case at a useful +E3SM is a high-performance computing application and generally requires a +capable compute cluster to run a scientifically validated case at a useful simulation speed. To run E3SM, it is recommended that you obtain time on a @@ -48,7 +48,7 @@ Please refer to [Running E3SM](https://e3sm.org/model/running-e3sm/) Contributing -------------------------------------------------------------------------------- Please refer to [Contributing](CONTRIBUTING.md) for details on our code development -process for submitting pull requests. +process. Acknowledgement -------------------------------------------------------------------------------- From 1a547c5acac4211b06dd59352198b903a64d835f Mon Sep 17 00:00:00 2001 From: Robert Jacob Date: Tue, 28 Sep 2021 19:17:41 -0500 Subject: [PATCH 6/7] Fix a few items in LICENSE Also make it more clear what the list of Institutions at the bottom is for. --- LICENSE | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/LICENSE b/LICENSE index 66727824b3ee..00f67d63b430 100644 --- a/LICENSE +++ b/LICENSE @@ -41,7 +41,8 @@ CESM is public domain software. ******************************************************************************* -Separable pieces with their own copyright and license: +Separable pieces with their own copyright and license. See code location +for details. Name Code Location Institution(s) License ------------------------------------------------------------------------------- @@ -52,8 +53,8 @@ CIME cime/ NCAR, SNL, ANL BSD GPTL share/timing author non-commerical MCT externals/mct ANL BSD YAKL externals/YAKL author BSD -cub externals/cub NVIDIA BSD-like -kokkos externals/kokkos NTESS, LLC BSD +cub externals/cub author, NVIDIA BSD +kokkos externals/kokkos SNL BSD Ocean/Ice under components/ ----------- ----------------- @@ -61,12 +62,12 @@ CICE cice LANL BSD MPAS Framework mpas-framework LANL BSD MPAS Ocean mpas-ocean LANL BSD MPAS SeaIce mpas-seaice LANL BSD -MPAS-Albany LandIce mpas-albany-landice LANL,SNL BSD +MPAS-Albany LandIce mpas-albany-landice LANL, SNL BSD Land under components/elm/src ----------- ------------------------ -Fates external_models/fates LBNL, NCAR, LANL BSD -Betr external_models/betr LBNL BSD +FATES external_models/fates LBNL, NCAR, LANL BSD +Betr external_models/sbetr LBNL, NCAR BSD MPP external_models/mpp LBNL BSD Atmosphere under components/eam/src @@ -74,21 +75,20 @@ Atmosphere under components/eam/src CLUBB physics/clubb authors -- rrtmg physics/rrtmg AER non-commercial rrtmgp physics/rrtmgp/external AER non-commercial -COSP2 physics/cosp2 authors BSD +Cosp2 physics/cosp2 authors BSD Cosp2/MISR physics/cosp2/external/src/simulator/MISR_simulator author BSD Cosp2/MODIS physics/cosp2/external/src/simulator/MODIS_simulator U Colo. BSD -Cosp2/actsim physics/cosp2/external/src/simulator/actsim CRNS BSD -Cosp2/icarus physics/cosp2/external/src/simulator/icarus LLNL BSD -Cosp2/parasol physics/cosp2/external/src/simulator/parasol CRNS BSD +Cosp2/actsim physics/cosp2/external/src/simulator/actsim CNRS BSD +Cosp2/icarus physics/cosp2/external/src/simulator/icarus BCC, LLNL BSD +Cosp2/parasol physics/cosp2/external/src/simulator/parasol CNRS BSD Cosp2/quikbeam physics/cosp2/external/src/simulator/quickbeam U Colo. BSD Cosp2/rrtov physics/cosp2/external/src/simulator/rrtov U Colo. BSD icarus-scops physics/icarus-scops BCC BSD HOMMEXX components/homme/src/share/cxx SNL BSD - components/homme/src/share/cxx/COPYRIGHT ------------------------------------------------------------------------------- -Institution Names: +Actual copyright holder for above Institutions: NCAR = University Corporation for Atmospheric Research LANL = Los Alamos National Security, LLC SNL = National Technology & Engineering Solutions of Sandia, LLC @@ -98,4 +98,5 @@ ANL = UChicago Argonne, LLC BCC = British Crown Copyright, the UK Met Office AER = Atmospheric & Environmental Research, Inc. CNRS = Centre National de la Recherche Scientifique +U Colo. = Regents of the University of Colorado ******************************************************************************* From 403bdf49aefc97e3696690fd8af9153bbe2631d4 Mon Sep 17 00:00:00 2001 From: Robert Jacob Date: Tue, 28 Sep 2021 20:38:05 -0500 Subject: [PATCH 7/7] Split up CIME CIME was split up so make LICENSE reflect that. --- LICENSE | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index 00f67d63b430..0ce2c2832b5a 100644 --- a/LICENSE +++ b/LICENSE @@ -49,7 +49,8 @@ Name Code Location Institution(s) License Software ----------- -CIME cime/ NCAR, SNL, ANL BSD +CIME cime/scripts NCAR, SNL BSD +cpl7 driver-mct/ NCAR, ANL BSD GPTL share/timing author non-commerical MCT externals/mct ANL BSD YAKL externals/YAKL author BSD