Skip to content

Update README.md #1311

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #1311

wants to merge 1 commit into from

Conversation

juliasloan25
Copy link
Member

Purpose

small changes to readme

@juliasloan25 juliasloan25 requested a review from kmdeck August 12, 2025 21:00
```

You are now ready to use `ClimaLand.jl`. To get started, we recommend reading the [documentation](https://clima.github.io/ClimaLand.jl/dev/).
You are now ready to use `ClimaLand.jl`. To get started, we recommend reading the [documentation](https://clima.github.io/ClimaLand.jl/stable/).

## Models
Copy link
Member

Choose a reason for hiding this comment

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

I believe @AlexisRenchon wants to add a few lines of code here showing how easy it is to setup and run a simulation! If so, that would be nice to include - either with him taking over this PR or in a followup PR.

(the changes you made look good, so I approved them)

Copy link
Member

Choose a reason for hiding this comment

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

I will make a follow up PR!

Copy link
Member Author

Choose a reason for hiding this comment

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

I have a PR open to set up and run a simple soil simulation in getting_started.md - maybe we can just point to that? #1267

Copy link
Member

Choose a reason for hiding this comment

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

I think it's good for now to point to it.

For a readme, it seems a bit long, there's 100+ lines?

I like how oceananigans readme has a simulation setup in a few lines

using Oceananigans
grid = RectilinearGrid(CPU(), size=(128, 128), x=(0, 2π), y=(0, 2π), topology=(Periodic, Periodic, Flat))
model = NonhydrostaticModel(; grid, advection=WENO())
ϵ(x, y) = 2rand() - 1
set!(model, u=ϵ, v=ϵ)
simulation = Simulation(model; Δt=0.01, stop_time=4)
run!(simulation)

I think to have something equivalent we would need a even higher level API (with more defaults setup) and possibly less dependency via a module?

But that's just a thought. I am not suggesting to do anything for now. Pointing to the simple example in the docs is good! We can discuss further if it would be useful or not to have a even higher level API. Maybe MC3 workshop will tell if users want that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants