Skip to content

Commit

Permalink
Merge branch 'rljacob/docs/update-v2' (PR #4566)
Browse files Browse the repository at this point in the history 
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
  • Loading branch information
@rljacob
rljacob committed Sep 29, 2021
2 parents b1909c0 + 403bdf4 commit 1e754ed
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 31 deletions.
7 changes: 5 additions & 2 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -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.
Expand All @@ -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?**

Expand Down
44 changes: 27 additions & 17 deletions LICENSE
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -41,46 +41,55 @@ 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
-------------------------------------------------------------------------------

Software
-----------
CIME cime/ NCAR, SNL, ANL BSD
MCT cime/src/externals/mct ANL BSD
GPTL cime/src/share/timing author non-commerical
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
cub externals/cub author, NVIDIA BSD
kokkos externals/kokkos SNL 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
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
FATES external_models/fates LBNL, NCAR, LANL BSD
Betr external_models/sbetr LBNL, NCAR 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 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
Expand All @@ -90,4 +99,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
*******************************************************************************
27 changes: 15 additions & 12 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------------------------------------------------------------------------------
Expand All @@ -26,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
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
Expand All @@ -45,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
--------------------------------------------------------------------------------
Expand All @@ -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.

0 comments on commit 1e754ed

Please sign in to comment.