Skip to content

linlintamu/private_fork_E3SM_repo

Repository files navigation

E3SM Logo

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.20240301.3

Please visit the project website or our Confluence site for further details.

For questions about the model, use Github Discussions.

See our Github-hosted documentation at https://e3sm-project.github.io/E3SM/.

Table of Contents

Quick Start

The Quick Start page includes instructions on obtaining the necessary code and input data for model setup and execution on a supported machine.

Supported Machines

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 Supported Machine.

Running

Please refer to Running E3SM for instructions on running the model.

Contributing

Please refer to Contributing for details on our code development process.

Acknowledgement

The Energy Exascale Earth System Model (E3SM) Project should be acknowledged in publications as the origin of the model using these guidelines.

In addition, the software should be cited. For your convenience, the following BibTeX entry is provided.

@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.20240301.3}},
	url = {https://dx.doi.org/10.11578/E3SM/dc.20240301.3},
	doi = {10.11578/E3SM/dc.20240301.3},
	year = 2024,
	month = mar,
}

License

The E3SM model is available under a BSD 3-clause license. Please see LICENSE for details.