diff --git a/AUTHORS.md b/AUTHORS.md index 05415e73..cfaf593d 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -1,8 +1,8 @@ # Authors -`JustRelax.jl`'s development is coordinated by a group of *principal developers*, +[JustRelax.jl](https://github.com/PTsolvers/JustRelax.jl)'s development is coordinated by a group of *principal developers*, who are also its main contributors and who can be contacted in case of -questions about `JustRelax.jl`. In addition, there are *contributors* who have +questions about [JustRelax.jl](https://github.com/PTsolvers/JustRelax.jl). In addition, there are *contributors* who have provided substantial additions or modifications. Together, these two groups form "The JustRelax.jl Authors". @@ -14,7 +14,7 @@ provided substantial additions or modifications. Together, these two groups form ## Contributors -The following people contributed major additions or modifications to `JustRelax.jl` and +The following people contributed major additions or modifications to [JustRelax.jl](https://github.com/PTsolvers/JustRelax.jl) and are listed in alphabetical order: * Sidney Beeler diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dbafbc66..8696e2bf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,12 +1,12 @@ # Contributing -`JustRelax.jl` is an open-source project and we are very happy to accept contributions +[JustRelax.jl](https://github.com/PTsolvers/JustRelax.jl) is an open-source project and we are very happy to accept contributions from the community. Please feel free to [open issues](https://github.com/PTsolvers/JustRelax.jl/issues/new) or submit patches (preferably as [pull requests](https://github.com/PTsolvers/JustRelax.jl/pulls)) any time. For planned larger contributions, it is often beneficial to get in contact with one of the principal developers first (see [AUTHORS.md](AUTHORS.md)). -`JustRelax.jl` and its contributions are licensed under the MIT license. As a contributor, you certify that all your +[JustRelax.jl](https://github.com/PTsolvers/JustRelax.jl) and its contributions are licensed under the MIT license. As a contributor, you certify that all your contributions are in conformance with the *Developer Certificate of Origin (Version 1.1)*, which is reproduced below. diff --git a/docs/src/index.md b/docs/src/index.md index 7b661c12..a38e8898 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -4,7 +4,7 @@ CurrentModule = JustRelax Need to solve a very large multi-physics problem on many GPUs in parallel? Just Relax! -`JustRelax.jl` is a collection of accelerated iterative pseudo-transient solvers using MPI and multiple CPU or GPU backends. It's part of the [PTSolvers organisation](https://ptsolvers.github.io) and +[JustRelax.jl](https://github.com/PTsolvers/JustRelax.jl) is a collection of accelerated iterative pseudo-transient solvers using MPI and multiple CPU or GPU backends. It's part of the [PTSolvers organisation](https://ptsolvers.github.io) and developed within the [GPU4GEO project](https://www.pasc-ch.org/projects/2021-2024/gpu4geo/). Current publications, outreach and news can be found on the [GPU4GEO website](https://ptsolvers.github.io/GPU4GEO/). The package relies on other packages as building blocks and parallelisation tools: diff --git a/docs/src/man/Blankenbach.md b/docs/src/man/Blankenbach.md index 6c6b8721..fda37d4e 100644 --- a/docs/src/man/Blankenbach.md +++ b/docs/src/man/Blankenbach.md @@ -4,7 +4,7 @@ Thermal convection benchmark from [Blankenbach et al., 1989](https://academic.o ## Initialize packages -Load `JustRelax.jl` necessary modules and define backend. +Load [JustRelax.jl](https://github.com/PTsolvers/JustRelax.jl) necessary modules and define backend. ```julia using JustRelax, JustRelax.JustRelax2D, JustRelax.DataIO const backend_JR = CPUBackend diff --git a/docs/src/man/ShearBands.md b/docs/src/man/ShearBands.md index 8dc45c69..99f4165b 100644 --- a/docs/src/man/ShearBands.md +++ b/docs/src/man/ShearBands.md @@ -1,10 +1,10 @@ # ShearBand benchmark -Shear Band benchmark to test the visco-elasto-plastic rheology implementation in `JustRelax.jl` +Shear Band benchmark to test the visco-elasto-plastic rheology implementation in [JustRelax.jl](https://github.com/PTsolvers/JustRelax.jl) ## Initialize packages -Load `JustRelax.jl` necessary modules and define backend. +Load [JustRelax.jl](https://github.com/PTsolvers/JustRelax.jl) necessary modules and define backend. ```julia using JustRelax, JustRelax.JustRelax2D, JustRelax.DataIO const backend_JR = CPUBackend diff --git a/docs/src/man/advection.md b/docs/src/man/advection.md index e2b2ac30..db75c963 100644 --- a/docs/src/man/advection.md +++ b/docs/src/man/advection.md @@ -1,7 +1,7 @@ # Field advection ## Particles-in-Cell -`JustRelax.jl` relies on [JustPIC.jl](https://github.com/JuliaGeodynamics/JustPIC.jl) for advections of particles containing material information. +[JustRelax.jl](https://github.com/PTsolvers/JustRelax.jl) relies on [JustPIC.jl](https://github.com/JuliaGeodynamics/JustPIC.jl) for advections of particles containing material information. ## Upwind diff --git a/docs/src/man/backend.md b/docs/src/man/backend.md index bc394b27..76b97d47 100644 --- a/docs/src/man/backend.md +++ b/docs/src/man/backend.md @@ -1,6 +1,6 @@ # Selecting the backend -`JustRelax.jl` supports three backends: the default CPU backend, and two GPU backends for Nvidia and AMD GPUs. The default CPU backend is selected upon loading JustRelax: +[JustRelax.jl](https://github.com/PTsolvers/JustRelax.jl) supports three backends: the default CPU backend, and two GPU backends for Nvidia and AMD GPUs. The default CPU backend is selected upon loading JustRelax: ```julia using JustRelax diff --git a/docs/src/man/installation.md b/docs/src/man/installation.md index 76bbfccf..e2cbb814 100644 --- a/docs/src/man/installation.md +++ b/docs/src/man/installation.md @@ -1,6 +1,6 @@ # Installation -`JustRelax.jl` is a registered package and can be added as follows: +[JustRelax.jl](https://github.com/PTsolvers/JustRelax.jl) is a registered package and can be added as follows: ```julia using Pkg; Pkg.add("JustRelax") @@ -12,11 +12,11 @@ julia> ] (@v1.10) pkg> add JustRelax ``` -However, as the API is changing and not every feature leads to a new release, one can also do -```julia-repl -add JustRelax#main -``` -which will clone the main branch of the repository. +!!! info "Install from a specific branch" + However, as the API is changing and not every new feature leads to a new release, one can also clone the main branch of the repository: + ```julia + add JustRelax#main + ``` After installation, you can test the package by running the following commands: ```julia-repl diff --git a/docs/src/man/material_physics.md b/docs/src/man/material_physics.md index ae6606ef..b179f246 100644 --- a/docs/src/man/material_physics.md +++ b/docs/src/man/material_physics.md @@ -1,3 +1,3 @@ # Material physics -`JustRelax.jl` is fully integrated with [GeoParams.jl](https://github.com/JuliaGeodynamics/GeoParams.jl/tree/main) to perform all the material physics computations. +[JustRelax.jl](https://github.com/PTsolvers/JustRelax.jl) is fully integrated with [GeoParams.jl](https://github.com/JuliaGeodynamics/GeoParams.jl/tree/main) to perform all the material physics computations.