Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update README #1003

Merged
merged 1 commit into from
Oct 11, 2024
Merged

update README #1003

merged 1 commit into from
Oct 11, 2024

Conversation

juliasloan25
Copy link
Member

@juliasloan25 juliasloan25 commented Oct 8, 2024

Purpose

Our README has become a bit out of date (e.g. specifying --threads=8 when starting julia), and isn't very informative to new users of the code.

This update to the README explains the commands to get started running the AMIP driver, where to find output, how to change the configuration file, how to run with GPU or MPI, and how to run on clima or central.

closes #983

Copy link
Member

@szy21 szy21 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Member

@trontrytel trontrytel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Maybe it would be good to give some estimates on how long the typical simulation takes on some example CPU/GPU configuration. And some estimate for memory needed to run and to store the output? Just so that when people copy/paste those commands they know what they sign up for

@juliasloan25 juliasloan25 force-pushed the js/readme branch 3 times, most recently from 824bd60 to 8876ef6 Compare October 10, 2024 22:43
@juliasloan25 juliasloan25 added the documentation Improvements or additions to documentation label Oct 10, 2024
@juliasloan25 juliasloan25 merged commit 23dc975 into main Oct 11, 2024
6 checks passed
@juliasloan25 juliasloan25 deleted the js/readme branch October 11, 2024 00:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add documentation for running AMIP
4 participants