Skip to content

Commit

Permalink
README: installation and image
Browse files Browse the repository at this point in the history
this commit adds installation of ClimaLand.jl instructions,
and an image of ClimaLand visualization via ClimaScope.
  • Loading branch information
AlexisRenchon committed Sep 19, 2024
1 parent 145b001 commit 633bbf0
Showing 1 changed file with 25 additions and 3 deletions.
28 changes: 25 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,36 @@ component) or standalone (single component) modes. </strong>

</div>

# ClimaLand.jl
ClimaLand.jl visualized with [ClimaScope](https://www.caltech.edu/about/news/data-to-discovery-art-climate) web dashboard:
![ClimaScope-page41-JPEG original](https://github.com/user-attachments/assets/07eb1914-cdcb-45bc-9cd6-21408b77b59c)

# Introduction

This is the repository of the CliMA land model code. Here are some notable features:
- ClimaLand has a modular design, models can be run as standalone (e.g., soil moisture only) or integrated (e.g., soil moisture and energy AND canopy AND snow, etc.)
- ClimaLand can simulate single columns, regional boxes, and global runs
- ClimaLand is CPU and GPU compatible
- ClimaLand welcome contributions: please feel free to reach out to us with questions about how to get started, create a branch, and extend our code. For example, a modeler might want to test a new stomatal conductance model.
- ClimaLand provides APIs and UIs at multiple levels.
- ClimaLand welcome contributions: please feel free to reach out to us with questions about how to get started, create a branch, and extend our code. For example, a modeler might want to test a new stomatal conductance model.
- ClimaLand provides APIs and UIs at multiple levels.

## Installation

To use ClimaLand.jl, first you need to [install Julia](https://julialang.org/downloads/).
Then, you can install ClimaLand.jl by doing:

```Julia
julia> using Pkg
julia> Pkg.add(ClimaLand)
```

Which is equivalent to doing

```Julia
julia> ] # typing the ] key with go into package REPL mode
pkg> add ClimaLand
```

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

## Models

Expand Down

0 comments on commit 633bbf0

Please sign in to comment.