Skip to content

Commit

Permalink
Merge branch 'uzerbinati/docs'
Browse files Browse the repository at this point in the history
  • Loading branch information
Umberto Zerbinati committed Jul 19, 2024
2 parents 70227f7 + 08b5650 commit d9803f9
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
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
```

0 comments on commit d9803f9

Please sign in to comment.