Skip to content

Commit

Permalink
Merge pull request #152 from psanan/psanan/2021-08-05/docs-typo-fix
Browse files Browse the repository at this point in the history
Docs: fix typo: "pre-build" --> "pre-built"
  • Loading branch information
boriskaus authored Aug 5, 2021
2 parents ff709d1 + 38e95e0 commit 5b07ca3
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The installation can be tested with

## BinaryBuilder Version

By default, the package uses a pre-build binary of
By default, the package uses a pre-built binary of
[`PETSc`](https://github.com/JuliaBinaryWrappers/PETSc_jll.jl) along with a
default installation of `MPI.jl`. Note that the distributed version of PETSc is using real,
`Float64` numbers; build details can be found
Expand All @@ -45,4 +45,4 @@ To see the currently set library use
```julia
using PETSc
PETSc.libs
```
```
2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

[PETSc.jl](https://github.com/JuliaParallel/PETSc.jl) is a Julia wrapper for the Portable, Extensible Toolkit for Scientific Computation [PETSc](https://petsc.org/release/documentation/manual/) package, which allows solving ordinary and partial differential equations in parallel on laptops or massively parallel high-performance systems.

The use of Julia greatly simplifies the code that developers have to write, while allowing to employ Julia features such as automatic differentiation. The Julia wrapper also comes with a pre-build library, which greatly simplifies the process of getting your first code working in parallel, on different operating systems. In many cases, the Julia code is significantly shorter than its C counterpart.
The use of Julia greatly simplifies the code that developers have to write, while allowing to employ Julia features such as automatic differentiation. The Julia wrapper also comes with a pre-built library, which greatly simplifies the process of getting your first code working in parallel, on different operating systems. In many cases, the Julia code is significantly shorter than its C counterpart.

This wrapper mimics the PETSc-functionality as closely as possible, but remains work in progress (meaning that not everything has been translated yet). See the official [user guide](https://petsc.org/release/overview/) if you want to learn more about PETSc in general. For Julia-specific examples, have a look at our [examples](https://github.com/JuliaParallel/PETSc.jl/tree/master/examples) or [tests](https://github.com/JuliaParallel/PETSc.jl/tree/master/test).
10 changes: 5 additions & 5 deletions docs/src/man/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,20 @@


- [Getting started](#getting-started)
- [1a. Installation using pre-build libraries](#1a-installation-using-pre-build-libraries)
- [1b. Installation using pre-build libraries](#1b-installation-using-pre-build-libraries)
- [1a. Installation using pre-built libraries](#1a-installation-using-pre-built-libraries)
- [1b. Installation using pre-built libraries](#1b-installation-using-pre-built-libraries)
- [2. Solving a linear system of equations](#2-solving-a-linear-system-of-equations)
- [3. Nonlinear example](#3-nonlinear-example)

### 1a. Installation using pre-build libraries
### 1a. Installation using pre-built libraries
The easiest way to install the package is:
```julia
julia> ]
(@v1.6) pkg> add https://github.com/JuliaParallel/PETSc.jl
```
which will install a pre-build PETSc library (`PETSc_jll`) as well as `MPI.jl` on your system. This will work both in serial and in parallel on your machine.
which will install a pre-built PETSc library (`PETSc_jll`) as well as `MPI.jl` on your system. This will work both in serial and in parallel on your machine.

### 1b. Installation using pre-build libraries
### 1b. Installation using pre-built libraries
On many high-performance clusters, you will have to use the provided `MPI` installation for that cluster and the default download above will not be sufficient. Alternatively, you may be interested in a PETSc installation that comes with additional external packages. Ensure that this PETSc installation is compiled as a dynamic (and not a static) library, after which you need to set the environmental variable `JULIA_PETSC_LIBRARY` to link to your PETSc installation:

```
Expand Down

0 comments on commit 5b07ca3

Please sign in to comment.