From c22352e20ed5a8607bf0ed47c45f8710857d21a0 Mon Sep 17 00:00:00 2001 From: Robert Jacob Date: Thu, 19 Apr 2018 15:16:17 -0500 Subject: [PATCH 1/6] Add a CONTRIBUTING file --- CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000000..e74c90305b28 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,32 @@ +## How to contribute to E3SM + +#### **Did you find a bug?** + +* Is it a bug in E3SM code? E3SM includes several codes that our developed externally. + See [LICENSE](https://github.com/E3SM-Project/E3SM/blob/master/LICENSE) for locations and report your bug in the original developers site. + +* Ensure the bug was not already reported by searching on our GitHub under [Issues](https://github.com/E3SM-Project/E3SM/issues) + +* If you are unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, including the case, machine and compiler and compiler version. + +#### **Do you want to fix an existing bug?** + +* Before you start writing code, please read [Developing E3SM](http://e3sm.org/model/running-e3sm/developing-e3sm/) to know more about our development workflow. + +* Open a new GitHub pull request with the patch. + +* Ensure the PR description clearly describes the problem and solution. Include 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. + +#### **Do you intend to add a new feature or change an existing one?** + +* We may not have the resources to test/evaluate new or changed features from non-staff. Your feature PR will get attention if its part of the E3SM science plan and coordinated by its management. + +* If you would like to collaborate on E3SM development, see [E3SM Collaboration](http://e3sm.org/about/collaboration/) + +#### **Do you have questions about the source code?** + +See our documentation at [e3sm.org](https://e3sm.org) From 9c8db37a8700f23080e8b41f4eb362bc81ba5560 Mon Sep 17 00:00:00 2001 From: Sarat Sreepathi Date: Thu, 19 Apr 2018 15:39:59 -0400 Subject: [PATCH 2/6] Update README.md for release The README contains basic information and includes references to related pages on the project website. --- README | 18 ------------------ README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 50 insertions(+), 18 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 7e4c3c942c77..000000000000 --- a/README +++ /dev/null @@ -1,18 +0,0 @@ -Energy Exascale Earth System Model (E3SM) -================================================================================ - -The Energy Exascale Earth System Model (E3SM) project, previously known as ACME, -is developing a computationally advanced coupled climate-energy model to -investigate the challenges posed by the interactions of weather-climate scale -variability with energy and related sectors. - -Please see web site below for further details: -https://climatemodeling.science.energy.gov/projects/energy-exascale-earth-system-model - - -Development: Getting Started --------------------------------------------------------------------------------- -Please see the following guide for up-to-date instructions: -https://acme-climate.atlassian.net/wiki/spaces/Docs/pages/1868455/Development+Getting+Started+Guide - - diff --git a/README.md b/README.md new file mode 100644 index 000000000000..9a700ce003d3 --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +Energy Exascale Earth System Model (E3SM) +================================================================================ + +E3SM is a state-of-the-art fully coupled model of the Earth's climate including +important biogeochemical and cryospheric processes. It is intended to address +the most challenging and demanding climate-change research problems and +Department of Energy mission needs while efficiently using DOE Leadership +Computing Facilities. + +Please visit the [project website](https://e3sm.org) for further details. + +Table of Contents +-------------------------------------------------------------------------------- +- [Quick Start](#quickstart) +- [Supported Machines](#supportedmachines) +- [Running](#running) +- [Contributing](#contributing) +- [License](#license) + +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. + +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 +simulation speed. + +To run E3SM, it is recommended that you obtain time on [Supported Machine] +(https://e3sm.org/model/running-e3sm/supported-machines/) + +Running +-------------------------------------------------------------------------------- +Please refer to [Running E3SM](https://e3sm.org/model/running-e3sm/) + for instructions on running the model. + +Contributing +-------------------------------------------------------------------------------- +Please refer to [Developing E3SM](https://e3sm.org/model/running-e3sm/developing-e3sm/) + for details on our code development process for submitting pull requests. + +License +-------------------------------------------------------------------------------- +The E3SM model became open development at the time of first model and data release. +Please see [LICENSE](LICENSE) for details. + + From 4367e93cde5eb4b0df81c754cd863c3b389b0106 Mon Sep 17 00:00:00 2001 From: Sarat Sreepathi Date: Thu, 19 Apr 2018 15:48:52 -0400 Subject: [PATCH 3/6] Add Acknowledgement to README Add text to README Fix link to supported machines. --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9a700ce003d3..832cf140f299 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,7 @@ Table of Contents - [Supported Machines](#supportedmachines) - [Running](#running) - [Contributing](#contributing) +- [Acknowledge](#acknowledge) - [License](#license) Quick Start @@ -29,8 +30,7 @@ E3SM is high-performance computing application and generally requires a cluster with several hundred nodes to run a scientifically validated case at a useful simulation speed. -To run E3SM, it is recommended that you obtain time on [Supported Machine] -(https://e3sm.org/model/running-e3sm/supported-machines/) +To run E3SM, it is recommended that you obtain time on a [Supported Machine](https://e3sm.org/model/running-e3sm/supported-machines/) Running -------------------------------------------------------------------------------- @@ -42,9 +42,14 @@ Contributing Please refer to [Developing E3SM](https://e3sm.org/model/running-e3sm/developing-e3sm/) for details on our code development process for submitting pull requests. +Acknowledge +-------------------------------------------------------------------------------- +The Energy Exascale Earth System Model (E3SM) Project should be acknowledged in +publications as the origin of model or data used in the research using [these +guidelines](https://e3sm.org/resources/policies/acknowledge-e3sm/). + License -------------------------------------------------------------------------------- The E3SM model became open development at the time of first model and data release. Please see [LICENSE](LICENSE) for details. - From ed5abe2c15feb9bb9d94f20f29e7d45d8e009c16 Mon Sep 17 00:00:00 2001 From: Sarat Sreepathi Date: Thu, 19 Apr 2018 16:27:33 -0400 Subject: [PATCH 4/6] Changes to README and CONTRIBUTING --- CONTRIBUTING.md | 33 +++++++++++++++++++++++---------- README.md | 11 +++++++---- 2 files changed, 30 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e74c90305b28..d1e8732edddc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,31 +2,44 @@ #### **Did you find a bug?** -* Is it a bug in E3SM code? E3SM includes several codes that our developed externally. - See [LICENSE](https://github.com/E3SM-Project/E3SM/blob/master/LICENSE) for locations and report your bug in the original developers site. +* 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. -* Ensure the bug was not already reported by searching on our GitHub under [Issues](https://github.com/E3SM-Project/E3SM/issues) +* Ensure the bug was not already reported by searching on our GitHub instance +under [Issues](https://github.com/E3SM-Project/E3SM/issues). -* If you are unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, including the case, machine and compiler and compiler version. +* If you are unable to find an open issue addressing the problem, open a new +one. Be sure to include a title, clear description, and as much relevant +information as possible, including the case, machine, compiler and compiler +version. #### **Do you want to fix an existing bug?** -* Before you start writing code, please read [Developing E3SM](http://e3sm.org/model/running-e3sm/developing-e3sm/) to know more about our development workflow. +* Before you start writing code, please read [Developing +E3SM](http://e3sm.org/model/running-e3sm/developing-e3sm/) to know more about +our development workflow. * Open a new GitHub pull request with the patch. -* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable. +* Ensure the PR description clearly describes the problem and solution. Include +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. +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. #### **Do you intend to add a new feature or change an existing one?** -* We may not have the resources to test/evaluate new or changed features from non-staff. Your feature PR will get attention if its part of the E3SM science plan and coordinated by its management. +* We may not have the resources to test/evaluate new or changed features from +non-staff. Your feature PR will get attention if its part of the E3SM science +plan and coordinated by its management. -* If you would like to collaborate on E3SM development, see [E3SM Collaboration](http://e3sm.org/about/collaboration/) +* If you would like to collaborate on E3SM development, see [E3SM +Collaboration](http://e3sm.org/about/collaboration/) #### **Do you have questions about the source code?** -See our documentation at [e3sm.org](https://e3sm.org) +See our documentation at [e3sm.org](https://e3sm.org). diff --git a/README.md b/README.md index 832cf140f299..aa5e4a766e60 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +[![E3SM Logo](https://e3sm.org/wp-content/themes/e3sm/assets/images/e3sm-logo.png)](https://e3sm.org) + Energy Exascale Earth System Model (E3SM) ================================================================================ @@ -30,7 +32,8 @@ E3SM is high-performance computing application and generally requires a cluster with several hundred nodes to run a scientifically validated case at a useful simulation speed. -To run E3SM, it is recommended that you obtain time on a [Supported Machine](https://e3sm.org/model/running-e3sm/supported-machines/) +To run E3SM, it is recommended that you obtain time on a +[Supported Machine](https://e3sm.org/model/running-e3sm/supported-machines/). Running -------------------------------------------------------------------------------- @@ -39,10 +42,10 @@ Please refer to [Running E3SM](https://e3sm.org/model/running-e3sm/) Contributing -------------------------------------------------------------------------------- -Please refer to [Developing E3SM](https://e3sm.org/model/running-e3sm/developing-e3sm/) - for details on our code development process for submitting pull requests. +Please refer to [Contributing](CONTRIBUTING.md) for details on our code development +process for submitting pull requests. -Acknowledge +Acknowledgement -------------------------------------------------------------------------------- The Energy Exascale Earth System Model (E3SM) Project should be acknowledged in publications as the origin of model or data used in the research using [these From 25dcf942072060e2f44654599e4706a0abb7dbf3 Mon Sep 17 00:00:00 2001 From: Robert Jacob Date: Thu, 19 Apr 2018 16:27:59 -0500 Subject: [PATCH 5/6] Add a codemeta.json file --- codemeta.json | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 codemeta.json diff --git a/codemeta.json b/codemeta.json new file mode 100644 index 000000000000..debd9c96c299 --- /dev/null +++ b/codemeta.json @@ -0,0 +1,17 @@ +{ + "@context": "https://raw.githubusercontent.com/mbjones/codemeta/master/codemeta.jsonld", + "@type": "SoftwareSourceCode", + "author": [ + { + "@type": "Organization", + "name": "E3SM Project", + } + ], + "identifier": "http://dx.doi.org/10.11578/E3SM/dc.20180418.36", + "codeRepository": "https://github.com/E3SM-Project/E3SM", + "datePublished": "2018-04-20", + "keywords": "climate modeling", + "license": "BSD", + "title": "Energy Exascale Earth System Model", + "version": "v1.0.0" +} From 6d2745a77103c414e59d50607cad26348cacac73 Mon Sep 17 00:00:00 2001 From: Sarat Sreepathi Date: Thu, 19 Apr 2018 19:00:57 -0400 Subject: [PATCH 6/6] Add BibTex for citing E3SM Also add a DOI link at top. --- README.md | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index aa5e4a766e60..69c6b7d4d7bb 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,8 @@ 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) + Please visit the [project website](https://e3sm.org) for further details. Table of Contents @@ -47,9 +49,25 @@ process for submitting pull requests. Acknowledgement -------------------------------------------------------------------------------- -The Energy Exascale Earth System Model (E3SM) Project should be acknowledged in -publications as the origin of model or data used in the research using [these -guidelines](https://e3sm.org/resources/policies/acknowledge-e3sm/). +The Energy Exascale Earth System Model (E3SM) Project should be acknowledged in +publications as the origin of the model using +[these guidelines](https://e3sm.org/resources/policies/acknowledge-e3sm/). + +In addition, the software should be cited. For your convenience, +the following BibTeX entry is provided. +```TeX +@misc{e3sm-model, + title = {{Energy Exascale Earth System Model (E3SM)}}, + 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, +} +``` License --------------------------------------------------------------------------------