xref: /petsc/src/binding/petsc4py/docs/source/index.rst (revision 42587f1cc62fbf5e6120960d51164cb5c93f95dc)
1================
2PETSc for Python
3================
4
5.. only:: html or man
6
7   :Author:       Lisandro Dalcin
8   :Contact:      dalcinl@gmail.com
9   :Web Site:     https://gitlab.com/petsc/petsc
10   :Date:         |today|
11
12.. topic:: Abstract
13
14   This document describes :mod:`petsc4py`, a Python_ wrapper to the PETSc_
15   libraries.
16
17   PETSc_ (the Portable, Extensible Toolkit for Scientific
18   Computation) is a suite of data structures and routines for the
19   scalable (parallel) solution of scientific applications modeled by
20   partial differential equations. It employs the MPI_ standard for
21   all message-passing communication.
22
23   This package provides an important subset of PETSc functionalities
24   and uses NumPy_ to efficiently manage input and output of array data.
25
26   A *good friend* of petsc4py is:
27
28      * mpi4py_: Python bindings for MPI_,
29        the *Message Passing Interface*.
30
31   Other projects depend on petsc4py:
32
33      * slepc4py_: Python bindings for SLEPc_,
34        the *Scalable Library for Eigenvalue Problem Computations*.
35
36.. include:: links.txt
37
38
39.. toctree::
40   :caption: Contents
41   :maxdepth: 2
42
43   overview
44   install
45   contributing
46   citing
47
48.. toctree::
49   :caption: Python specifics
50   :maxdepth: 2
51
52   reference
53   petsc_python_types
54   petsc_options
55   demo/demo
56   documentation_standards
57