Skip to content

Commit

Permalink
Update main README.md with link to arXiv paper
Browse files Browse the repository at this point in the history
  • Loading branch information
JHopeCollins authored Sep 30, 2024
1 parent 01f2c44 commit 986e57e
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@ asQ is designed to allow fast prototyping of new ParaDiag methods, while still b
This is achieved using the Firedrake and PETSc libraries.
The finite element models are defined by specifying the weak form using [Firedrake, "*an automated system for the portable solution of partial differential equations using the finite element method*](https://www.firedrakeproject.org/)", and the linear and nonlinear solvers required are provided by [PETSc, "*the Portable, Extensible Toolkit for Scientific Computation*"](https://petsc.org/release/).

See the arXiv paper https://arxiv.org/abs/2409.18792 for a description and demonstration of asQ. The code used for this paper can be found in the [asq_manuscript_examples](https://github.com/firedrakeproject/asQ/tree/master/asq_manuscript_examples) directory.

## ParaDiag

ParaDiag is a parallel-in-time method, meaning that is solves for multiple timesteps of a timeseries simultaneously, rather than one at a time like traditional serial-in-time methods.
ParaDiag is a parallel-in-time method, meaning that it solves for multiple timesteps of a timeseries simultaneously, rather than one at a time like traditional serial-in-time methods.
This [review article](https://arxiv.org/abs/2005.09158) provides a good introduction to the method.
asQ implements the ParaDiag-II family of methods based on creating a block-circulant approximation to the all-at-once system which can be block-diagonalised with the FFT and solved efficiently in parallel.

Expand All @@ -22,7 +23,7 @@ To install asQ, pass the arguments `--install asQ` to the `firedrake-install` sc

## Getting started

The best place to start is the examples from the asQ release paper on arXiv in [this directory](https://github.com/firedrakeproject/asQ/tree/master/asq_manuscript_examples).
The best place to start is the arXiv paper and associated examples in [this directory](https://github.com/firedrakeproject/asQ/tree/master/asq_manuscript_examples).

Other examples can be found in the [examples directory](https://github.com/firedrakeproject/asQ/tree/master/examples) and more advanced scripts can be found in the [case studies directory](https://github.com/firedrakeproject/asQ/tree/master/case_studies), including scripts for the shallow water equations and a model for stratigraphic evolution of the sea floor.

Expand Down

0 comments on commit 986e57e

Please sign in to comment.