-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
21 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,24 @@ | ||
# ngsPETSc | ||
|
||
ngsPETSc is an interface between PETSc and NGSolve/NETGEN that enables the use of NETGEN meshes and geometries in PETSc-based solvers while providing NGSolve users access to the wide array of linear, nonlinear solvers, and time-steppers available in PETSc. | ||
|
||
[![ngsPETSc](https://github.com/UZerbinati/ngsPETSc/actions/workflows/ngsPETSc.yml/badge.svg)](https://github.com/UZerbinati/ngsPETSc/actions/workflows/ngsPETSc.yml) | ||
[![Documentation Status](https://readthedocs.org/projects/ngspetsc/badge/?version=latest)](https://ngspetsc.readthedocs.io/en/latest/?badge=latest) | ||
|
||
## Installation | ||
If you already have NGSolve (with MPI support) and PETSc installed, you can install ngsPETSc via pip: | ||
```bash | ||
|
||
git clone https://github.com/UZerbinati/ngsPETSc.git | ||
cd ngsPETSc | ||
pip install . | ||
``` | ||
Alternatively, you can also build PETSc, SLEPc, and NGSolve from source following the instructions in the [documentation](https://ngspetsc.readthedocs.io/en/latest/installation.html). | ||
|
||
## Getting started | ||
|
||
To get started with ngsPETSc, check out the [documentation](https://ngspetsc.readthedocs.io/en/latest/). | ||
To test the installation, you can run the tests in the `tests` folder, via the Makefile in the root directory of the repository: | ||
```bash | ||
make test | ||
``` |