Skip to content

Commit a0ef6f6

Browse files
authored
Merge branch 'e3sm/add-docs' (PR #2300)
Add remaining top-level documents [BFB]
2 parents 30c13f8 + 6d2745a commit a0ef6f6

File tree

4 files changed

+138
-18
lines changed

4 files changed

+138
-18
lines changed

CONTRIBUTING.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
## How to contribute to E3SM
2+
3+
#### **Did you find a bug?**
4+
5+
* Is it a bug in E3SM code? E3SM includes several codes that are developed
6+
externally.
7+
See [LICENSE](LICENSE) for
8+
locations and report your bug in the original developers site.
9+
10+
* Ensure the bug was not already reported by searching on our GitHub instance
11+
under [Issues](https://github.com/E3SM-Project/E3SM/issues).
12+
13+
* If you are unable to find an open issue addressing the problem, open a new
14+
one. Be sure to include a title, clear description, and as much relevant
15+
information as possible, including the case, machine, compiler and compiler
16+
version.
17+
18+
#### **Do you want to fix an existing bug?**
19+
20+
* Before you start writing code, please read [Developing
21+
E3SM](http://e3sm.org/model/running-e3sm/developing-e3sm/) to know more about
22+
our development workflow.
23+
24+
* Open a new GitHub pull request with the patch.
25+
26+
* Ensure the PR description clearly describes the problem and solution. Include
27+
the relevant issue number if applicable.
28+
29+
#### **Did you fix whitespace, format code, or make a purely cosmetic patch?**
30+
31+
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.
33+
34+
#### **Do you intend to add a new feature or change an existing one?**
35+
36+
* We may not have the resources to test/evaluate new or changed features from
37+
non-staff. Your feature PR will get attention if its part of the E3SM science
38+
plan and coordinated by its management.
39+
40+
* If you would like to collaborate on E3SM development, see [E3SM
41+
Collaboration](http://e3sm.org/about/collaboration/)
42+
43+
#### **Do you have questions about the source code?**
44+
45+
See our documentation at [e3sm.org](https://e3sm.org).

README

Lines changed: 0 additions & 18 deletions
This file was deleted.

README.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
[![E3SM Logo](https://e3sm.org/wp-content/themes/e3sm/assets/images/e3sm-logo.png)](https://e3sm.org)
2+
3+
Energy Exascale Earth System Model (E3SM)
4+
================================================================================
5+
6+
E3SM is a state-of-the-art fully coupled model of the Earth's climate including
7+
important biogeochemical and cryospheric processes. It is intended to address
8+
the most challenging and demanding climate-change research problems and
9+
Department of Energy mission needs while efficiently using DOE Leadership
10+
Computing Facilities.
11+
12+
DOI: [10.11578/E3SM/dc.20180418.36](http://dx.doi.org/10.11578/E3SM/dc.20180418.36)
13+
14+
Please visit the [project website](https://e3sm.org) for further details.
15+
16+
Table of Contents
17+
--------------------------------------------------------------------------------
18+
- [Quick Start](#quickstart)
19+
- [Supported Machines](#supportedmachines)
20+
- [Running](#running)
21+
- [Contributing](#contributing)
22+
- [Acknowledge](#acknowledge)
23+
- [License](#license)
24+
25+
Quick Start
26+
--------------------------------------------------------------------------------
27+
The [Quick Start](https://e3sm.org/model/running-e3sm/e3sm-quick-start/) page
28+
includes instructions on obtaining the necessary code and input data for model
29+
setup and execution.
30+
31+
Supported Machines
32+
--------------------------------------------------------------------------------
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
35+
simulation speed.
36+
37+
To run E3SM, it is recommended that you obtain time on a
38+
[Supported Machine](https://e3sm.org/model/running-e3sm/supported-machines/).
39+
40+
Running
41+
--------------------------------------------------------------------------------
42+
Please refer to [Running E3SM](https://e3sm.org/model/running-e3sm/)
43+
for instructions on running the model.
44+
45+
Contributing
46+
--------------------------------------------------------------------------------
47+
Please refer to [Contributing](CONTRIBUTING.md) for details on our code development
48+
process for submitting pull requests.
49+
50+
Acknowledgement
51+
--------------------------------------------------------------------------------
52+
The Energy Exascale Earth System Model (E3SM) Project should be acknowledged in
53+
publications as the origin of the model using
54+
[these guidelines](https://e3sm.org/resources/policies/acknowledge-e3sm/).
55+
56+
In addition, the software should be cited. For your convenience,
57+
the following BibTeX entry is provided.
58+
```TeX
59+
@misc{e3sm-model,
60+
title = {{Energy Exascale Earth System Model (E3SM)}},
61+
author = {{E3SM Project}},
62+
abstractNote = {{E3SM} is a state-of-the-art fully coupled model of the {E}arth's
63+
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,
69+
}
70+
```
71+
72+
License
73+
--------------------------------------------------------------------------------
74+
The E3SM model became open development at the time of first model and data release.
75+
Please see [LICENSE](LICENSE) for details.
76+

codemeta.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"@context": "https://raw.githubusercontent.com/mbjones/codemeta/master/codemeta.jsonld",
3+
"@type": "SoftwareSourceCode",
4+
"author": [
5+
{
6+
"@type": "Organization",
7+
"name": "E3SM Project",
8+
}
9+
],
10+
"identifier": "http://dx.doi.org/10.11578/E3SM/dc.20180418.36",
11+
"codeRepository": "https://github.com/E3SM-Project/E3SM",
12+
"datePublished": "2018-04-20",
13+
"keywords": "climate modeling",
14+
"license": "BSD",
15+
"title": "Energy Exascale Earth System Model",
16+
"version": "v1.0.0"
17+
}

0 commit comments

Comments
 (0)