Skip to content

Commit e24f23d

Browse files
authored
Update README.md
1 parent 1bdb35d commit e24f23d

File tree

1 file changed

+26
-5
lines changed

1 file changed

+26
-5
lines changed

README.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,45 @@ Repository for the implementation of the stochastic stirring forcing and jet dra
44
[Barnes and Hartmann, 2011](https://journals.ametsoc.org/view/journals/atsc/68/12/jas-d-11-039.1.xml?tab_body=fulltext-display#bib14)
55
and [Vallis et al. 2004](https://journals.ametsoc.org/view/journals/atsc/61/3/1520-0469_2004_061_0264_amasdm_2.0.co_2.xml).
66

7-
See also https://github.com/SpeedyWeather/SpeedyWeather.jl/issues/394
7+
## Background
88

9-
To be used like
9+
See
10+
- https://github.com/SpeedyWeather/SpeedyWeather.jl/issues/394
11+
- Issue https://github.com/SpeedyWeather/StochasticStir.jl/issues/3
12+
13+
## Installation
14+
15+
Via Julia's package manager (opened with `]`)
16+
17+
```julia
18+
julia>] add https://github.com/SpeedyWeather/StochasticStir.jl
19+
```
20+
or via `using Pkg; Pkg.add("https://github.com/SpeedyWeather/StochasticStir.jl")`.
21+
This package is not registered in Julia's general registry, so you have to specify
22+
the whole URL as above. Requires SpeedyWeather.jl v0.8 or higher.
23+
24+
## Usage
1025

1126
```julia
1227
using SpeedyWeather
1328
using StochasticStir
1429

1530
# model components
1631
spectral_grid = SpectralGrid(trunc=42,nlev=1)
17-
forcing = StochasticStirring(spectral_grid,latitude=45)
32+
forcing = StochasticStirring(spectral_grid,latitude=45,strength=7e-11)
1833
drag = JetDrag(spectral,time_scale=Day(6))
1934
initial_conditions = StartFromRest()
2035

2136
# construct the model and initialize
2237
model = BarotropicModel(;spectral_grid,initial_conditions,forcing,drag)
2338
simulation = initialize!(model)
2439

25-
# now run
26-
run!(simulation)
40+
# now run and store output
41+
run!(simulation,period=Day(100),output=true)
2742
```
43+
44+
## Gallery
45+
46+
A visualisation of the above simulation
47+
48+
https://github.com/SpeedyWeather/StochasticStir.jl/assets/25530332/3924a9fd-8515-4628-8128-f555e6054616

0 commit comments

Comments
 (0)