Skip to content

Commit 24192a7

Browse files
authored
Revise installation instructions for ClimaAtmos.jl
Updated the installation instructions for ClimaAtmos.jl and added steps for exploring the state variable.
1 parent ebada88 commit 24192a7

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

docs/src/installation_instructions.md renamed to docs/src/getting_started.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
## Installation instructions
1+
## Installing Julia
2+
3+
ClimaAtmos is provided as a Julia package, so it requires having Julia installed. Information about Julia packages is available on the [Julia website](https://julialang.org).
4+
5+
First, download and install Julia by following the instructions at [https://julialang.org/downloads/](https://julialang.org/downloads/). Then, you can launch a Julia REPL by running `$ julia --project`
6+
7+
## Installing ClimaAtmos.jl
28

39
ClimaAtmos.jl is a [registered Julia package](https://julialang.org/packages/). To install
410

@@ -38,3 +44,12 @@ The following terms are frequently used within the source code and between colla
3844
conditions, precipitation fluxes), atmospheric model configurations, and
3945
slab model properties.
4046
- `t`: Current simulation time.
47+
48+
The state `Y` is not assigned by default. If you want to explore the state variable, you can follow the steps below. Note that all but the last step below are executed by the [driver](.buildkite/ci_driver.jl).
49+
50+
```Julia
51+
import ClimaAtmos as CA
52+
config = CA.AtmosConfig([your_path_to_config_file])
53+
simulation = CA.get_simulation(config)
54+
Y = simulation.integrator.u
55+
```

0 commit comments

Comments
 (0)