xref: /petsc/src/binding/petsc4py/docs/source/index.rst (revision 55a74a43bb44613d95e937906bec3b8c3581b432)
15808f684SSatish Balay================
25808f684SSatish BalayPETSc for Python
35808f684SSatish Balay================
45808f684SSatish Balay
5*55a74a43SLisandro Dalcin.. only:: html or man
6*55a74a43SLisandro Dalcin
75808f684SSatish Balay   :Author:       Lisandro Dalcin
85808f684SSatish Balay   :Contact:      dalcinl@gmail.com
9eaf87d4bSBarry Smith   :Web Site:     https://gitlab.com/petsc/petsc
105808f684SSatish Balay   :Date:         |today|
115808f684SSatish Balay
12*55a74a43SLisandro Dalcin.. topic:: Abstract
135808f684SSatish Balay
14*55a74a43SLisandro Dalcin   This document describes petsc4py_, a Python_ wrapper to the PETSc_
15*55a74a43SLisandro Dalcin   libraries.
165808f684SSatish Balay
17*55a74a43SLisandro Dalcin   PETSc_ (the Portable, Extensible Toolkit for Scientific
18*55a74a43SLisandro Dalcin   Computation) is a suite of data structures and routines for the
19*55a74a43SLisandro Dalcin   scalable (parallel) solution of scientific applications modeled by
20*55a74a43SLisandro Dalcin   partial differential equations. It employs the MPI_ standard for
21*55a74a43SLisandro Dalcin   all message-passing communication.
22*55a74a43SLisandro Dalcin
23*55a74a43SLisandro Dalcin   This package provides an important subset of PETSc functionalities
24*55a74a43SLisandro Dalcin   and uses NumPy_ to efficiently manage input and output of array data.
25*55a74a43SLisandro Dalcin
26*55a74a43SLisandro Dalcin   A *good friend* of petsc4py is:
27*55a74a43SLisandro Dalcin
28*55a74a43SLisandro Dalcin      * mpi4py_: Python bindings for MPI_,
29*55a74a43SLisandro Dalcin        the *Message Passing Interface*.
30*55a74a43SLisandro Dalcin
31*55a74a43SLisandro Dalcin   Other projects depends on petsc4py:
32*55a74a43SLisandro Dalcin
33*55a74a43SLisandro Dalcin      * slepc4py_: Python bindings for SLEPc_,
34*55a74a43SLisandro Dalcin        the *Scalable Library for Eigenvalue Problem Computations*.
355808f684SSatish Balay
365808f684SSatish Balay.. include:: links.txt
37*55a74a43SLisandro Dalcin
38*55a74a43SLisandro Dalcin
39*55a74a43SLisandro Dalcin.. toctree::
40*55a74a43SLisandro Dalcin   :caption: Contents
41*55a74a43SLisandro Dalcin   :maxdepth: 2
42*55a74a43SLisandro Dalcin
43*55a74a43SLisandro Dalcin   overview
44*55a74a43SLisandro Dalcin   demo/demo
45*55a74a43SLisandro Dalcin   petsc_options
46*55a74a43SLisandro Dalcin   petsc_python_types
47*55a74a43SLisandro Dalcin   reference
48*55a74a43SLisandro Dalcin   citing
49*55a74a43SLisandro Dalcin   install
50*55a74a43SLisandro Dalcin   documentation_standards
51