Skip to content

NumericalEarth/Breeze.jl

Repository files navigation

Breeze.jl

Fast and friendly Julia software for atmospheric fluid dynamics on CPUs and GPUs. https://numericalearth.github.io/BreezeDocumentation/dev

Documentation Documentation Benchmarks
Ask us anything ColPrac: Contributor's Guide on Collaborative Practices for Community Packages DOI

Breeze is a library for simulating atmospheric flows and weather phenomena, such as clouds and hurricanes, on both CPUs and GPUs. Built on Oceananigans, Breeze extends its grids, solvers, and advection schemes with atmospheric dynamics, thermodynamics, microphysics, and radiation.

Learn more in the documentation and examples, or get in touch on the NumericalEarth Slack or GitHub discussions.

Installation

Breeze is a registered Julia package. First install Julia; suggested version 1.12. See juliaup README for how to install 1.12 and make that version the default.

Then launch Julia and type

julia> using Pkg

julia> Pkg.add("Breeze")

If you want to live on the cutting edge, you can use Pkg.add(; url="https://github.com/NumericalEarth/Breeze.jl.git", rev="main") to install from main. For more information, see the Pkg.jl documentation.

Quick start

A warm bubble rising through a neutral atmosphere in 15 lines:

using Breeze, Oceananigans.Units, CairoMakie

grid = RectilinearGrid(CPU(); size=(256, 256), x=(-10e3, 10e3), z=(0, 10e3),
                       topology=(Periodic, Flat, Bounded))

reference = ReferenceState(grid; potential_temperature=300)
model = AtmosphereModel(grid; dynamics=AnelasticDynamics(reference), advection=WENO(order=5))
set!(model, θ = (x, z) -> 300 + 2cos(π/2 * min(1, √(x^2 + (z - 2000)^2) / 2000))^2)

simulation = Simulation(model; Δt=2, stop_time=25minutes)
conjure_time_step_wizard!(simulation, cfl=0.7)
run!(simulation)

heatmap(liquid_ice_potential_temperature(model), colormap=:thermal, axis=(; aspect=2))
image

Swap CPU() for GPU() to run on an NVIDIA GPU.

Features

  • Anelastic dynamics with a pressure Poisson solver that filters sound waves
  • Compressible dynamics with split-explicit acoustic substepping (horizontally explicit, vertically implicit) using SSP-RK3 or Wicker-Skamarock RK3
  • Moist thermodynamics with liquid-ice potential temperature and static energy formulations
  • Cloud microphysics: saturation adjustment, Kessler, one- and two-moment bulk schemes via CloudMicrophysics.jl
  • Radiative transfer: gray, clear-sky, and all-sky solvers via RRTMGP.jl
  • High-order advection including bounds-preserving WENO schemes
  • LES turbulence closures for subgrid-scale mixing
  • Surface physics: Coriolis forces, bulk drag, heat and moisture fluxes
  • Kinematic driver and parcel model for rapid prototyping of microphysics and radiation schemes
  • GPU-first: use GPU() to run very fast on NVIDIA GPUs

Selected examples

Below we've included thumbnails that link to a few of Breeze's examples. Check out the documentation for the full list.


Cloudy thermal bubble

BOMEX shallow convection

RICO trade-wind cumulus

Prescribed SST convection

Cloudy Kelvin-Helmholtz instability

Acoustic wave in shear flow

For instance, by increasing the resolution of the cloudy Kelvin-Helmholtz instability to Nx=1536 and Nz=1024 and decreasing the timestep to Δt = 0.1, we get

wave_clouds.mp4

Or cranking up the resolution of the thermal bubble example to size = (1024, 512):

thermal_bubble.mp4

We ran the BOMEX example at 25 m resolution and a 2x bigger grid, and used the data to produce a visualization of the resulting clouds:

528887367-7f3058a5-76eb-4151-83ab-cba10ae32a62.mp4

Roadmap and a call to action

Our goal is to build a very fast, easy-to-learn, productive tool for atmospheric research, teaching, and forecasting, as well as a platform for the development of algorithms, numerical methods, parameterizations, microphysical schemes, and atmosphere model components. This goal can't be achieved by the efforts of a single group, project, or even a single community. Such a lofty aim can only be realized by a wide-ranging and sustained collaboration of passionate people. Maybe that includes you - consider it! Model development is hard but rewarding, and builds useful skills for a myriad of pursuits.

The goals of the current group of model developers include developing

  • Advanced microphysics: Predicted Particle Property (P3) bulk microphysics, spectral bin schemes, and Lagrangian superdroplet methods for high-fidelity cloud and precipitation modeling.
  • Terrain-following coordinates: Smooth sigma coordinates for flow over complex topography
  • Open boundaries and nesting: Open boundary conditions are useful for both idealized simulations and realistic one- and two-way nested simulations for high-resolution downscaling.
  • Coupled atmosphere-ocean simulations: Support for high-resolution coupled atmosphere-ocean simulations via NumericalEarth.jl.

If you have ideas, dreams, or criticisms that can make Breeze and its future better, don't hesitate to speak up by opening issues and contributing pull requests.

Relationship to Oceananigans

Breeze is built on Oceananigans.jl, an ocean modeling package that provides grids, fields, operators, advection schemes, time-steppers, turbulence closures, and output infrastructure. Breeze extends Oceananigans with atmospheric dynamics, thermodynamics, microphysics, and radiation to create a complete atmosphere simulation capability. The two packages share a common philosophy: fast, flexible, GPU-native Julia code with a user interface designed for productivity and experimentation. To learn these foundational components of Breeze, please see the Oceananigans documentation.

If you're familiar with Oceananigans, you'll feel right at home with Breeze. If you're new to both, Breeze is a great entry point—and the skills you develop transfer directly to ocean and climate modeling with Oceananigans and ClimaOcean.jl.

Citing

If you use Breeze for research, teaching, or fun, we'd be grateful if you give credit by citing the corresponding Zenodo record, e.g.,

Wagner, G. L. et al. (2026). NumericalEarth/Breeze.jl. Zenodo. DOI:10.5281/zenodo.18050353

About

🌪 Limited area LES-to-mesoscale atmosphere simulations based on Oceananigans

Resources

License

Stars

Watchers

Forks

Contributors

Languages