Skip to content

trixi-framework/TrixiAtmo.jl

🌎 TrixiAtmo.jl 🌍

Docs-stable Docs-dev Slack Build Status Codecov Coveralls License: MIT DOI

TrixiAtmo.jl is a numerical simulation package focused on atmospheric flows. It builds upon Trixi.jl, a generic flow solver for conservation laws, implementing discontinuous Galerkin methods and written in Julia.

Currently available features include:

  • Compressible Euler and shallow water models on cubed sphere meshes, discretizing the atmosphere or its two-dimensional surface
  • Moist compressible Euler equations, including cloud and rain microphysics
  • Flux-differencing formulations, including entropy-stable schemes

Installation

If you have not yet installed Julia, please follow the instructions for your operating system. TrixiAtmo.jl works with Julia v1.10 and newer. We recommend using the latest stable release of Julia.

TrixiAtmo.jl is a registered Julia package and can be installed using Julia's package manager. In addition, TrixiAtmo.jl requires the numerical solver framework Trixi.jl as well as relevant sub-packages of OrdinaryDiffEq.jl for time integration. Executing the following in the Julia REPL will install the packages required to run the cases in the examples directory, along with Trixi2Vtk.jl, which enables visualization of the resulting HDF5-based output files:

julia> using Pkg

julia> Pkg.add(["TrixiAtmo", "Trixi", "OrdinaryDiffEqLowStorageRK", "OrdinaryDiffEqSSPRK", "Trixi2Vtk"])

Usage

In the Julia REPL, first load the package Trixi.jl

julia> using Trixi

Then start a simulation by executing

julia> trixi_include("examples/euler/dry_air/buoyancy/elixir_gemein_bubble.jl")

Please see our documentation for more advanced setups.

Referencing

You can directly refer to TrixiAtmo.jl as

@software{trixiatmo_18297711,
  author       = {Artiano, Marco and
                  Gassner, Gregor and
                  Geihe, Benedict and
                  Montoya, Tristan and
                  Ranocha, Hendrik and
                  Rueda-Ramírez, Andrés and
                  Schlottke-Lakemper, Michael},
  title        = {TrixiAtmo.jl}: athmospheric flow simulations with {Trixi.jl},
  month        = jan,
  year         = 2026,
  publisher    = {Zenodo},
  version      = {0.1.0},
  doi          = {10.5281/zenodo.18297711},
  url          = {https://doi.org/10.5281/zenodo.18297711},
}

Authors

TrixiAtmo.jl is maintained by the Trixi authors. It was initiated by Andrés Rueda-Ramírez (Polytechnic University of Madrid (UPM), Spain), Benedict Geihe, and Tristan Montoya (University of Cologne, Germany). The full list of contributors can be found in AUTHORS.md.

License and contributing

TrixiAtmo.jl is licensed under the MIT license (see LICENSE.md). Since TrixiAtmo.jl is an open-source project, we are very happy to accept contributions from the community. To get in touch with the developers, join us on Slack or create an issue.

Acknowledgments

This project has benefited from funding from the Federal Ministry of Education and Research (BMBF) through the following grants:

  • Project grant "Adaptive earth system modeling with significantly reduced computation time for exascale supercomputers (ADAPTEX)" (funding id: 16ME0668K)
  • Project grant "ICON-DG" of the WarmWorld initiative (funding id: 01LK2315B)

About

Simulation package for atmospheric models based on Trixi.jl

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Contributors

Languages