Skip to content

trixi-framework/TrixiAtmo.jl

Repository files navigation

🌎 TrixiAtmo.jl 🌍

Docs-dev Slack Build Status Codecov Coveralls License: MIT

Note: This repository is still in its alpha stage and anything might change at any time and without warning.

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 not a registered Julia package yet, and therefore needs to be downloaded manually and then run from within the cloned directory:

git clone https://github.com/trixi-framework/TrixiAtmo.jl.git
julia --project=@.

In addition, TrixiAtmo.jl requires the numerical solver framework Trixi.jl, relevant sub-packages of OrdinaryDiffEq.jl for time integration, and Plots.jl for visualization, which can be installed by executing the following in the Julia REPL:

julia> using Pkg

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

Usage

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

julia> using Trixi

Then start a simulation by executing

julia> trixi_include("examples/elixir_euler_warmbubble.jl")

Please see our documentation for more advanced setups.

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).

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

Security policy

Stars

Watchers

Forks

Releases

No releases published

Contributors 11

Languages