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.

Sign up for GitHub

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

Jump to bottom

Update README.md #339

Merged
merged 2 commits into from
May 31, 2023
Merged

Update README.md #339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0d58caa
Update README.md
milankl May 31, 2023
f701129
add output.md to docs
milankl May 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,14 @@ simulation = initialize!(model)
run!(simulation,n_days=10,output=true)
```
and you will see
```
Weather is speedy: run 0001 100%|█████████| Time: 0:00:04 (531.88 years/day)
```
Hurray🥳 In 4 seconds we just simulated 10 days of the Earth's atmosphere at a speed of 500 years per day.
This simulation used a T31 spectral resolution on an octahedral Gaussian grid (~400km resolution) solving
the dry primitive equations.

<img src="https://github.com/SpeedyWeather/SpeedyWeather.jl/assets/25530332/a04fbb10-1cc1-4f77-93f2-7bdf047f277d" width="450"><br>

Hurray🥳 In 5 seconds we just simulated 10 days of the Earth's atmosphere at a speed of 440 years per day.
This simulation used a T31 spectral resolution on an [octahedral Gaussian grid](https://speedyweather.github.io/SpeedyWeather.jl/dev/grids/#Implemented-grids) (~400km resolution) solving
the dry primitive equations. The [UnicodePlot](https://github.com/JuliaPlots/UnicodePlots.jl) will give
you a snapshot of surface vorticity at the last time step. The plots resolution is not representative,
but allows a quick check of what has been simulated. The [NetCDF output](https://speedyweather.github.io/SpeedyWeather.jl/dev/output/) is independent of the UnicodePlot.

More examples in the [How to run SpeedyWeather](https://speedyweather.github.io/SpeedyWeather.jl/dev/how_to_run_speedy/)
section of the [documentation](https://speedyweather.github.io/SpeedyWeather.jl/dev).
Expand All @@ -61,7 +63,7 @@ https://user-images.githubusercontent.com/25530332/229872856-bdcab69a-2226-4e9b-

SpeedyWeather.jl can also solve the 2D barotropic vorticity equations on the sphere.
Here, we use single-threaded Float32 (single precision) at a resolution of T340 (40km) on
an [octahedral Gaussian grid](https://speedyweather.github.io/SpeedyWeather.jl/dev/grids/#Implemented-grids) (quadratic truncation).
an [octahedral Gaussian grid](https://speedyweather.github.io/SpeedyWeather.jl/dev/grids/#Implemented-grids).
Initial conditions are randomly distributed relative vorticity on a slowly rotating Earth ($\Omega = 10^{-6}\text{ s}^{-1}$) and no forcing is applied

https://github.com/SpeedyWeather/SpeedyWeather.jl/assets/25530332/8a7c6758-950f-424d-8ece-0480295386b3
Expand Down
1 change: 1 addition & 0 deletions docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ makedocs(
"Parameterizations"=>"parametrizations.md",
"Boundary conditions"=>"boundary_conditions.md",
"Extending SpeedyWeather"=>"extending.md",
"NetCDF output"=>"output.md",
"Submodule: RingGrids"=>"ringgrids.md",
"Submodule: LowerTriangularMatrices"=>"lowertriangularmatrices.md",
"Submodule: SpeedyTransforms"=>"speedytransforms.md",
Expand Down
5 changes: 5 additions & 0 deletions docs/src/output.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# NetCDF output

SpeedyWeather.jl uses NetCDF to output the data of a simulation.
The following describes the details of this and how to change the way in which the NetCDF output is written.
There are many options to this available.
Loading