Skip to content

Commit 29e436c

Browse files
committed
More in docs
1 parent 8378be1 commit 29e436c

File tree

2 files changed

+10
-15
lines changed

2 files changed

+10
-15
lines changed

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1111

1212
- Configuration of PETSc installation using Preferences.jl.
1313
- High-level wrapper of KSP solvers.
14-
- Support for sequential runs
15-
- Support for parallel parallel runs with PartitionedArrays.jl
14+
- Support for sequential runs.
15+
- Support for parallel parallel runs with PartitionedArrays.jl.
1616
- Commonly used low-level API for KSP solvers.

docs/src/index.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,17 @@ Documentation for [PETSC](https://github.com/fverdugo/PETSC.jl).
88

99
## What
1010

11-
The goal of this package is to provide a high-level Julia interface to solvers from the PETSc library.
11+
The goal of this package is to provide a high-level Julia interface to solvers from the [PETSc](https://petsc.org/) library.
1212
At this moment it wraps linear solvers from the KSP module in PETSc, but the goal is to also
1313
provide nonlinear solvers from the SNES module in PETSc. The package also provides a low-level interface with functions
14-
that are almost 1-to-1 to the corresponding C functions for advanced users. The low level API is mostly taken from GridapPETSc.jl.
14+
that are almost 1-to-1 to the corresponding C functions for advanced users. The low level API is mostly taken from [GridapPETSc.jl](https://github.com/gridap/GridapPETSc.jl).
1515

16-
## Why
16+
## Features
1717

18-
The main difference of this package with respect to other Julia bindings to PETSc (e.g., PETSc.jl),
19-
is that our high-level interface is based on pure Julia types.
20-
I.e., the high-level interface only provides new functions, and the inputs and outputs of the
21-
such functions are pure Julia types. For instance, the functions to solve systems of linear equations
22-
take standard Julia (sparse) matrices and vectors. For parallel computations, one can use the pure
23-
Julia parallel sparse matrices and vectors implemented in PartitionedArrays.jl.
18+
- Configuration of PETSc installation using [Preferences.jl](https://github.com/JuliaPackaging/Preferences.jl).
19+
- High-level wrapper of KSP solvers.
20+
- Support for sequential runs.
21+
- Support for parallel parallel runs with [PartitionedArrays.jl](https://github.com/fverdugo/PartitionedArrays.jl).
22+
- Commonly used low-level API for KSP solvers.
2423

25-
## Related packages
26-
27-
- https://github.com/JuliaParallel/PETSc.jl
28-
- https://github.com/gridap/GridapPETSc.jl
2924

0 commit comments

Comments
 (0)