Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,16 @@ PFLARE adds new methods to PETSc, including:
1) Polynomial approximate inverses, e.g., GMRES and Neumann polynomials
2) Reduction multigrids, e.g., AIRG, nAIR and lAIR
3) CF splittings, e.g., PMISR DDC
4) Extracting diagonally dominant submatrices
4) Methods to extract diagonally dominant submatrices

## Quick start

You can get started with PFLARE in one of three ways:
You can get started with PFLARE in one of four ways:

* To run the Jupyter notebooks in `notebooks/` in your browser (without requiring any local install), click the Binder badge above (may take several minutes to build). These notebooks provide an introduction to some of the methods in PFLARE.
* To download a Docker image with PFLARE and dependencies installed, run `docker run -it stevendargaville/pflare && make check`
* To build from source, please see [docs/installation.md](docs/installation.md)
* PFLARE is now available directly through the PETSc configure with: `--download-pflare`, see [docs/installation.md](docs/installation.md)
* To run the Jupyter notebooks in `notebooks/` in your browser without requiring a local install, click the Binder badge above
* To download a Docker image with PFLARE installed, run `docker run -it stevendargaville/pflare && make check`
* To build from source, see [docs/installation.md](docs/installation.md)

## Documentation

Expand All @@ -53,10 +54,10 @@ and the Jupyter notebooks:

| Path | Contents |
|---|---|
| [notebooks/01_getting_started.ipynb](notebooks/01_getting_started.ipynb) | Introduction to PFLARE |
| [notebooks/01_getting_started.ipynb](notebooks/01_getting_started.ipynb) | Introduce PFLARE |
| [notebooks/02_pcpflareinv.ipynb](notebooks/02_pcpflareinv.ipynb) | Examine some of the approximate inverses found in PCPFLAREINV |
| [notebooks/03_cf_splitting.ipynb](notebooks/03_cf_splitting.ipynb) | Visualise the C/F splitting and explore the PMISR-DDC algorithm |
| [notebooks/04_pcair.ipynb](notebooks/04_pcair.ipynb) | Introduction to PCAIR and the AIRG method |
| [notebooks/04_pcair.ipynb](notebooks/04_pcair.ipynb) | Introduce PCAIR and the AIRG method |
| [notebooks/05_parallel.ipynb](notebooks/05_parallel.ipynb) | Discuss PCAIR, parallelism and GPUs |
| [notebooks/06_reuse.ipynb](notebooks/06_reuse.ipynb) | Discuss PCAIR and reuse |

Expand Down
Loading