Metadata-Version: 2.1
Name: ngsPETSc
Version: 0.0.5
Summary: NGSolve/Netgen interface to PETSc.
Author-email: Umberto Zerbinati <umberto.zerbinati@maths.ox.ac.uk>, "Patrick E. Farrell" <patrick.farrell@maths.ox.ac.uk>, Stefano Zampini <stefano.zampini@kaust.edu.sa>, Jack Betteridge <J.Betteridge@imperial.ac.uk>
Maintainer-email: Umberto Zerbinati <umberto.zerbinati@maths.ox.ac.uk>
License: MIT License
        
        Copyright (c) 2023 Umberto Zerbinati
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        
Project-URL: Documentation, https://ngspetsc.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/NGSolve/ngsPETSc
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 3 - Alpha
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: mpi4py
Requires-Dist: numpy
Requires-Dist: scipy
Provides-Extra: dev
Requires-Dist: pylint; extra == "dev"
Requires-Dist: pytest; extra == "dev"

# 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
```
