Skip to content

Commit 1e754ed

Browse files
rljacobrljacob
authored
Merge branch 'rljacob/docs/update-v2' (PR #4566)
Update README, LICENSE and CONTRIBUTING for v2. The DOI for v2 is reserved and won't be active until after the tag is made. Fixes #4134
2 parents b1909c0 + 403bdf4 commit 1e754ed

File tree

3 files changed

+47
-31
lines changed

3 files changed

+47
-31
lines changed

‎CONTRIBUTING.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
* Is it a bug in E3SM code? E3SM includes several codes that are developed
66
externally.
77
See [LICENSE](LICENSE) for
8-
locations and report your bug in the original developers site.
8+
locations and, if appropriate, report your bug in the original developers site.
99

1010
* Ensure the bug was not already reported by searching on our GitHub instance
1111
under [Issues](https://github.com/E3SM-Project/E3SM/issues).
@@ -17,6 +17,8 @@ version.
1717

1818
#### **Do you want to fix an existing bug?**
1919

20+
* Thank you!
21+
2022
* Before you start writing code, please read [Developing
2123
E3SM](http://e3sm.org/model/running-e3sm/developing-e3sm/) to know more about
2224
our development workflow.
@@ -29,7 +31,8 @@ the relevant issue number if applicable.
2931
#### **Did you fix whitespace, format code, or make a purely cosmetic patch?**
3032

3133
Changes that are cosmetic in nature and do not add anything substantial to the
32-
stability, functionality, or testability of E3SM will generally not be accepted.
34+
stability, functionality, or testability of E3SM will generally not be accepted
35+
from non-staff.
3336

3437
#### **Do you intend to add a new feature or change an existing one?**
3538

‎LICENSE‎

Lines changed: 27 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Except for the separable pieces descibed below, E3SM is released
22
under the following 3-Clause BSD Open Source license.
33

44
*******************************************************************************
5-
Copyright © 2018, UChicago Argonne, LLC All Rights Reserved
5+
Copyright ©2021, UChicago Argonne, LLC All Rights Reserved
66

77
Software Name: Energy Exascale Earth System Model (E3SM)
88

@@ -41,46 +41,55 @@ CESM is public domain software.
4141

4242
*******************************************************************************
4343

44-
Separable Pieces with their own copyright and license:
44+
Separable pieces with their own copyright and license. See code location
45+
for details.
4546

4647
Name Code Location Institution(s) License
4748
-------------------------------------------------------------------------------
4849

4950
Software
5051
-----------
51-
CIME cime/ NCAR, SNL, ANL BSD
52-
MCT cime/src/externals/mct ANL BSD
53-
GPTL cime/src/share/timing author non-commerical
52+
CIME cime/scripts NCAR, SNL BSD
53+
cpl7 driver-mct/ NCAR, ANL BSD
54+
GPTL share/timing author non-commerical
55+
MCT externals/mct ANL BSD
56+
YAKL externals/YAKL author BSD
57+
cub externals/cub author, NVIDIA BSD
58+
kokkos externals/kokkos SNL BSD
5459

5560
Ocean/Ice under components/
5661
----------- -----------------
5762
CICE cice LANL BSD
63+
MPAS Framework mpas-framework LANL BSD
5864
MPAS Ocean mpas-ocean LANL BSD
5965
MPAS SeaIce mpas-seaice LANL BSD
60-
MPAS-Albany LandIce mpas-albany-landice LANL,SNL BSD
66+
MPAS-Albany LandIce mpas-albany-landice LANL, SNL BSD
6167

62-
Land under components/clm/src
68+
Land under components/elm/src
6369
----------- ------------------------
64-
Fates external_models/fates LBNL, NCAR, LANL BSD
65-
Betr external_models/betr LBNL BSD
70+
FATES external_models/fates LBNL, NCAR, LANL BSD
71+
Betr external_models/sbetr LBNL, NCAR BSD
6672
MPP external_models/mpp LBNL BSD
6773

68-
Atmosphere under components/cam/src
74+
Atmosphere under components/eam/src
6975
----------- ------------------------
7076
CLUBB physics/clubb authors --
7177
rrtmg physics/rrtmg AER non-commercial
72-
COSP physics/cosp BCC BSD
73-
Cosp/MISR physics/cosp/MISR_simulator author BSD
74-
Cosp/LIDAR physics/cosp/actsim CNRS BSD
75-
Cosp/quickbeam physics/cosp/quickbeam author BSD
76-
Cosp/MODIS physics/cosp/MODIS_simulator U Colo. BSD
78+
rrtmgp physics/rrtmgp/external AER non-commercial
79+
Cosp2 physics/cosp2 authors BSD
80+
Cosp2/MISR physics/cosp2/external/src/simulator/MISR_simulator author BSD
81+
Cosp2/MODIS physics/cosp2/external/src/simulator/MODIS_simulator U Colo. BSD
82+
Cosp2/actsim physics/cosp2/external/src/simulator/actsim CNRS BSD
83+
Cosp2/icarus physics/cosp2/external/src/simulator/icarus BCC, LLNL BSD
84+
Cosp2/parasol physics/cosp2/external/src/simulator/parasol CNRS BSD
85+
Cosp2/quikbeam physics/cosp2/external/src/simulator/quickbeam U Colo. BSD
86+
Cosp2/rrtov physics/cosp2/external/src/simulator/rrtov U Colo. BSD
7787
icarus-scops physics/icarus-scops BCC BSD
7888
HOMMEXX components/homme/src/share/cxx SNL BSD
79-
components/homme/src/share/cxx/COPYRIGHT
8089

8190
-------------------------------------------------------------------------------
8291

83-
Institution Names:
92+
Actual copyright holder for above Institutions:
8493
NCAR = University Corporation for Atmospheric Research
8594
LANL = Los Alamos National Security, LLC
8695
SNL = National Technology & Engineering Solutions of Sandia, LLC
@@ -90,4 +99,5 @@ ANL = UChicago Argonne, LLC
9099
BCC = British Crown Copyright, the UK Met Office
91100
AER = Atmospheric & Environmental Research, Inc.
92101
CNRS = Centre National de la Recherche Scientifique
102+
U Colo. = Regents of the University of Colorado
93103
*******************************************************************************

‎README.md‎

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,12 @@ the most challenging and demanding climate-change research problems and
99
Department of Energy mission needs while efficiently using DOE Leadership
1010
Computing Facilities.
1111

12-
DOI: [10.11578/E3SM/dc.20180418.36](http://dx.doi.org/10.11578/E3SM/dc.20180418.36)
12+
DOI: [10.11578/E3SM/dc.20210927.1](http://dx.doi.org/10.11578/E3SM/dc.20210927.1)
1313

14-
Please visit the [project website](https://e3sm.org) for further details.
14+
Please visit the [project website](https://e3sm.org) or our [Confluence site](https://acme-climate.atlassian.net/wiki/spaces/DOC/overview)
15+
for further details.
16+
17+
For questions about the model, use [Github Discussions](https://github.com/E3SM-Project/E3SM/discussions)
1518

1619
Table of Contents
1720
--------------------------------------------------------------------------------
@@ -26,12 +29,12 @@ Quick Start
2629
--------------------------------------------------------------------------------
2730
The [Quick Start](https://e3sm.org/model/running-e3sm/e3sm-quick-start/) page
2831
includes instructions on obtaining the necessary code and input data for model
29-
setup and execution.
32+
setup and execution on a supported machine.
3033

3134
Supported Machines
3235
--------------------------------------------------------------------------------
33-
E3SM is high-performance computing application and generally requires a cluster
34-
with several hundred nodes to run a scientifically validated case at a useful
36+
E3SM is a high-performance computing application and generally requires a
37+
capable compute cluster to run a scientifically validated case at a useful
3538
simulation speed.
3639

3740
To run E3SM, it is recommended that you obtain time on a
@@ -45,7 +48,7 @@ Please refer to [Running E3SM](https://e3sm.org/model/running-e3sm/)
4548
Contributing
4649
--------------------------------------------------------------------------------
4750
Please refer to [Contributing](CONTRIBUTING.md) for details on our code development
48-
process for submitting pull requests.
51+
process.
4952

5053
Acknowledgement
5154
--------------------------------------------------------------------------------
@@ -61,16 +64,16 @@ the following BibTeX entry is provided.
6164
author = {{E3SM Project}},
6265
abstractNote = {{E3SM} is a state-of-the-art fully coupled model of the {E}arth's
6366
climate including important biogeochemical and cryospheric processes.},
64-
howpublished = {[Computer Software] \url{https://dx.doi.org/10.11578/E3SM/dc.20180418.36}},
65-
url = {https://dx.doi.org/10.11578/E3SM/dc.20180418.36},
66-
doi = {10.11578/E3SM/dc.20180418.36},
67-
year = 2018,
68-
month = apr,
67+
howpublished = {[Computer Software] \url{https://dx.doi.org/10.11578/E3SM/dc.20210927.1}},
68+
url = {https://dx.doi.org/10.11578/E3SM/dc.20210927.1},
69+
doi = {10.11578/E3SM/dc.20210927.1},
70+
year = 2021,
71+
month = sep,
6972
}
7073
```
7174

7275
License
7376
--------------------------------------------------------------------------------
74-
The E3SM model became open development at the time of first model and data release.
77+
The E3SM model is available under a BSD 3-clause license.
7578
Please see [LICENSE](LICENSE) for details.
7679

0 commit comments

Comments
 (0)