Skip to content

Commit

Permalink
Merge branch 'e3sm/add-docs' (PR #2300)
Browse files Browse the repository at this point in the history
Add remaining top-level documents

[BFB]
  • Loading branch information
rljacob authored Apr 20, 2018
2 parents 30c13f8 + 6d2745a commit a0ef6f6
Show file tree
Hide file tree
Showing 4 changed files with 138 additions and 18 deletions.
45 changes: 45 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
## How to contribute to E3SM

#### **Did you find a bug?**

* 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 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, 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.

* 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).
18 changes: 0 additions & 18 deletions README

This file was deleted.

76 changes: 76 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
[![E3SM Logo](https://e3sm.org/wp-content/themes/e3sm/assets/images/e3sm-logo.png)](https://e3sm.org)

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.

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
--------------------------------------------------------------------------------
- [Quick Start](#quickstart)
- [Supported Machines](#supportedmachines)
- [Running](#running)
- [Contributing](#contributing)
- [Acknowledge](#acknowledge)
- [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 a
[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 [Contributing](CONTRIBUTING.md) for details on our code development
process for submitting pull requests.

Acknowledgement
--------------------------------------------------------------------------------
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
--------------------------------------------------------------------------------
The E3SM model became open development at the time of first model and data release.
Please see [LICENSE](LICENSE) for details.

17 changes: 17 additions & 0 deletions codemeta.json
Original file line number Diff line number Diff line change
@@ -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"
}

0 comments on commit a0ef6f6

Please sign in to comment.