JustRelax.jl

Appearance

JustRelax.jlSolving multi-physical geodynamic problems

A collection of iterative accelerated pseudo-transient solvers using MPI for distributed computing on GPUs and CPUs.

Getting Started
API Reference 📚
View on GitHub
JustRelax.jl
🚀

Backend Agnostic

Effortlessly execute your code on GPUs and CPUs with ParallelStencils.jl.

🛠️

Governing equations

Governing equations of the solvers using the accelerated pseudo-transient method.

⚡

Examples

An overview of available examples from shear bands to 2D subduction.

🧩

Extensibility

Provides a natural repository for contributions of new solvers for use by the larger community.

What is JustRelax.jl? ​

JustRelax.jl is a collection of accelerated iterative pseudo-transient solvers using MPI for distributed memory parallelisation and running on GPUs or CPUs.

The package relies on other packages as building blocks and parallelisation tools:

Current publications, outreach and news can be found on the GPU4GEO website.

How to Install JustRelax.jl? ​

To install JustRelax.jl, one can simply add it using the Julia package manager by running the following command in the Julia REPL:

julia
julia> using Pkg

julia> Pkg.add("JustRelax")

After the package is installed, one can load the package by using:

julia
julia> using JustRelax

If you want to use the latest unreleased version of JustRelax.jl, you can run the following command:

julia
julia> using Pkg

julia> Pkg.add(url="https://github.com/PTsolvers/JustRelax.jl")

Example miniapps ​

Example and benchmark miniapps solving a variety of geodynamic-related problems can be readily run from the miniapps folder. To get started, instantiate the miniapps environment and run your favourite one:

shell
cd miniapps

julia --project=.
julia
julia> import Pkg

julia> Pkg.instantiate()

Funding ​

The development of this package is supported by the GPU4GEO and ∂GPU4GEO PASC projects. More information about the GPU4GEO project can be found on the GPU4GEO website.