From 9f34a7ff0c3866af92fbb1a617320d68cfc1e52b Mon Sep 17 00:00:00 2001 From: Fredrik Ekre Date: Thu, 16 Jan 2025 14:20:37 +0100 Subject: [PATCH] Fix links in README --- README.md | 42 ++++++++++++++++-------------------------- 1 file changed, 16 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 5dfd1db..dbc6ec0 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,13 @@ # HYPRE.jl -| **Documentation** | **Build Status** | -|:------------------------- |:------------------------------------- | -| [![][docs-img]][docs-url] | [![][gh-actions-img]][gh-actions-url] | +[![Documentation](https://img.shields.io/badge/docs-latest%20release-blue.svg)](https://fredrikekre.github.io/HYPRE.jl/) +[![Test](https://github.com/fredrikekre/HYPRE.jl/actions/workflows/Test.yml/badge.svg?branch=master&event=push)](https://github.com/fredrikekre/HYPRE.jl/actions/workflows/Test.yml) +[![Codecov](https://codecov.io/github/fredrikekre/HYPRE.jl/graph/badge.svg)](https://codecov.io/github/fredrikekre/HYPRE.jl) +[![code style: runic](https://img.shields.io/badge/code_style-%E1%9A%B1%E1%9A%A2%E1%9A%BE%E1%9B%81%E1%9A%B2-black)](https://github.com/fredrikekre/Runic.jl) -[Julia][julia] interface to [HYPRE][hypre] ("high performance preconditioners and solvers -featuring multigrid methods for the solution of large, sparse linear systems of equations on -massively parallel computers"). +[Julia](https://julialang.org) interface to [HYPRE](https://github.com/hypre-space/hypre) +("high performance preconditioners and solvers featuring multigrid methods for the solution +of large, sparse linear systems of equations on massively parallel computers"). While the main purpose of HYPRE is to solve problems on multiple cores, it can also be used for single core problems. HYPRE.jl aims to make it easy to use both modes of operation, with @@ -22,7 +23,7 @@ HYPRE.jl can be installed from the Pkg REPL (press `]` in the Julia REPL to ente (@v1) pkg> add HYPRE ``` -To configure MPI, see the [documentation for MPI.jl][mpi-docs]. +To configure MPI, see the [documentation for MPI.jl](https://juliaparallel.org/MPI.jl/). ## Changes @@ -35,9 +36,10 @@ Some basic usage examples are shown below. See the [documentation][docs-url] for ### Example: Single-core solve with standard sparse matrices It is possible to use Julia's standard sparse arrays (`SparseMatrixCSC` from the -[SparseArrays.jl][sparse-stdlib] standard library, and `SparseMatrixCSR` from the -[SparseMatricesCSR.jl][sparsecsr] package) directly in HYPRE.jl. For example, to solve -`Ax = b` with conjugate gradients: +[SparseArrays.jl](https://github.com/JuliaSparse/SparseArrays.jl) standard library, and +`SparseMatrixCSR` from the +[SparseMatricesCSR.jl](https://github.com/gridap/SparseMatricesCSR.jl) package) directly in +HYPRE.jl. For example, to solve `Ax = b` with conjugate gradients: ```julia # Initialize linear system @@ -53,10 +55,10 @@ x = HYPRE.solve(cg, A, b) ### Example: Multi-core solve using PartitionedArrays.jl -For multi-core problems it is possible to use [PartitionedArrays.jl][partarrays] directly -with HYPRE.jl. Once the linear system is setup the solver interface is identical. For -example, to solve `Ax = b` with bi-conjugate gradients and an algebraic multigrid -preconditioner: +For multi-core problems it is possible to use +[PartitionedArrays.jl](https://github.com/fverdugo/PartitionedArrays.jl) directly with +HYPRE.jl. Once the linear system is setup the solver interface is identical. For example, to +solve `Ax = b` with bi-conjugate gradients and an algebraic multigrid preconditioner: ```julia # Initialize linear system @@ -72,15 +74,3 @@ bicg = HYPRE.BiCGSTAB(; Precond = precond) # Compute the solution x = HYPRE.solve(bicg, A, b) ``` - - -[julia]: https://julialang.org/ -[hypre]: https://github.com/hypre-space/hypre -[mpi-docs]: https://juliaparallel.org/MPI.jl/ -[sparse-stdlib]: https://github.com/JuliaSparse/SparseArrays.jl -[sparsecsr]: https://github.com/gridap/SparseMatricesCSR.jl -[partarrays]: https://github.com/fverdugo/PartitionedArrays.jl -[docs-img]: https://img.shields.io/badge/docs-stable%20release-blue.svg -[docs-url]: https://fredrikekre.github.io/HYPRE.jl/ -[gh-actions-img]: https://github.com/fredrikekre/HYPRE.jl/actions/workflows/Test.yml/badge.svg?branch=master&event=push -[gh-actions-url]: https://github.com/fredrikekre/HYPRE.jl/actions/workflows/Test.yml?query=branch%3Amaster