|
| 1 | +[](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 | + |
0 commit comments