Browse Source

Add CHANGELOG.md and update README.md.

pull/6/head
Fredrik Ekre 3 years ago
parent
commit
caaac66857
  1. 30
      CHANGELOG.md
  2. 23
      README.md

30
CHANGELOG.md

@ -0,0 +1,30 @@
# HYPRE.jl changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
## [1.2.0] - 2022-10-12
### Added
- Added assembler interface to assemble `HYPREMatrix` and/or `HYPREVector` directly without
an intermediate sparse structure in Julia. ([#5][github-5])
## [1.1.0] - 2022-10-05
### Added
- Added support for MPI.jl version 0.20.x (in addition to the existing version 0.19.x
support). ([#2][github-2])
## [1.0.0] - 2022-07-28
Initial release of HYPRE.jl.
[github-2]: https://github.com/fredrikekre/HYPRE.jl/pull/2
[github-5]: https://github.com/fredrikekre/HYPRE.jl/pull/5
[1.0.0]: ttps://github.com/fredrikekre/HYPRE.jl/releases/tag/v1.0.0
[1.1.0]: https://github.com/fredrikekre/HYPRE.jl/compare/v1.0.0...v1.1.0
[1.2.0]: https://github.com/fredrikekre/HYPRE.jl/compare/v1.1.0...v1.2.0
[Unreleased]: https://github.com/fredrikekre/HYPRE.jl/compare/v1.2.0...HEAD

23
README.md

@ -14,7 +14,25 @@ an interface that should be familiar to Julia programmers. This README includes
examples -- refer to the [documentation][docs-url] for more details, and for information examples -- refer to the [documentation][docs-url] for more details, and for information
about the included solvers and preconditioners and how to configure them. about the included solvers and preconditioners and how to configure them.
## Example: Single-core solve with standard sparse matrices ## Installation
HYPRE.jl can be installed from the Pkg REPL (press `]` in the Julia REPL to enter):
```
(@v1) pkg> add HYPRE
```
To configure MPI, see the [documentation for MPI.jl][mpi-docs].
## Changes
All notable changes are documented in [CHANGELOG.md](CHANGELOG.md).
## Usage
Some basic usage examples are shown below. See the [documentation][docs-url] for details.
### Example: Single-core solve with standard sparse matrices
It is possible to use Julia's standard sparse arrays (`SparseMatrixCSC` from the It is possible to use Julia's standard sparse arrays (`SparseMatrixCSC` from the
[SparseArrays.jl][sparse-stdlib] standard library, and `SparseMatrixCSR` from the [SparseArrays.jl][sparse-stdlib] standard library, and `SparseMatrixCSR` from the
@ -33,7 +51,7 @@ cg = HYPRE.PCG()
x = HYPRE.solve(cg, A, b) x = HYPRE.solve(cg, A, b)
``` ```
## Example: Multi-core solve using PartitionedArrays.jl ### Example: Multi-core solve using PartitionedArrays.jl
For multi-core problems it is possible to use [PartitionedArrays.jl][partarrays] directly 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 with HYPRE.jl. Once the linear system is setup the solver interface is identical. For
@ -58,6 +76,7 @@ x = HYPRE.solve(bicg, A, b)
[julia]: https://julialang.org/ [julia]: https://julialang.org/
[hypre]: https://github.com/hypre-space/hypre [hypre]: https://github.com/hypre-space/hypre
[mpi-docs]: https://juliaparallel.org/MPI.jl/
[sparse-stdlib]: https://github.com/JuliaSparse/SparseArrays.jl [sparse-stdlib]: https://github.com/JuliaSparse/SparseArrays.jl
[sparsecsr]: https://github.com/gridap/SparseMatricesCSR.jl [sparsecsr]: https://github.com/gridap/SparseMatricesCSR.jl
[partarrays]: https://github.com/fverdugo/PartitionedArrays.jl [partarrays]: https://github.com/fverdugo/PartitionedArrays.jl

Loading…
Cancel
Save