Skip to content

Commit be1f3e3

Browse files
committed
update docs
1 parent e737132 commit be1f3e3

File tree

2 files changed

+6
-9
lines changed

2 files changed

+6
-9
lines changed

docs/Project.toml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
[deps]
22
CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
33
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
4-
LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"
54
Oceananigans = "9e8cae18-63c1-5223-a75c-80ca9d6e9a09"
65

76
[compat]

docs/src/index.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
# Breeze.jl
22

3-
Documentation for Breeze.jl
3+
Fast, friendly atmosphere simulations on CPUs and GPUs.
44

5-
## Overview
6-
7-
Breeze.jl is a Julia package for finite volume GPU and CPU large eddy simulations (LES) of atmospheric flows.
8-
Under the hood, Breeze's abstractions, design, and finite volume engine are based on [Oceananigans](https://github.com/CliMA/Oceananigans.jl).
5+
Breeze provides software for flexible software package for finite volume atmosphere simulations on CPUs and GPUs, based on [Oceananigans](https://github.com/CliMA/Oceananigans.jl).
6+
Like Oceanaingans, it provides a radically productive user interface that makes simple simulations easy, and complex, creative simulations possible.
97

108
## Features
119

12-
Breeze provides two ways to simulate atmospheric flows:
10+
Breeze provides two ways to simulate moist atmospheres:
1311

1412
* A [`MoistAirBuoyancy`](@ref) that can be used with [Oceananigans](https://clima.github.io/OceananigansDocumentation/stable/)' [`NonhydrostaticModel`](https://clima.github.io/OceananigansDocumentation/stable/appendix/library/#Oceananigans.Models.NonhydrostaticModels.NonhydrostaticModel-Tuple{}) to simulate atmospheric flows with the Boussinesq approximation.
1513

@@ -58,13 +56,13 @@ model = NonhydrostaticModel(; grid, advection, buoyancy,
5856
tracers = (:θ, :q),
5957
boundary_conditions = (θ=θ_bcs, q=q_bcs))
6058
61-
Δθ = 5 # ᵒK
59+
Δθ = 2 # ᵒK
6260
Tₛ = reference_constants.reference_potential_temperature # K
6361
θᵢ(x, z) = Tₛ + Δθ * z / grid.Lz + 1e-2 * Δθ * randn()
6462
qᵢ(x, z) = 0 # 1e-2 + 1e-5 * rand()
6563
set!(model, θ=θᵢ, q=qᵢ)
6664
67-
simulation = Simulation(model, Δt=10, stop_time=2hours)
65+
simulation = Simulation(model, Δt=60, stop_time=2hours)
6866
conjure_time_step_wizard!(simulation, cfl=0.7)
6967
7068
run!(simulation)

0 commit comments

Comments
 (0)