xref: /petsc/src/binding/petsc4py/docs/source/index.rst (revision 552edb6364df478b294b3111f33a8f37ca096b20)
15808f684SSatish Balay================
25808f684SSatish BalayPETSc for Python
35808f684SSatish Balay================
45808f684SSatish Balay
555a74a43SLisandro Dalcin.. only:: html or man
655a74a43SLisandro 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
1255a74a43SLisandro Dalcin.. topic:: Abstract
135808f684SSatish Balay
14*6f336411SStefano Zampini   This document describes :mod:`petsc4py`, a Python_ wrapper to the PETSc_
1555a74a43SLisandro Dalcin   libraries.
165808f684SSatish Balay
1755a74a43SLisandro Dalcin   PETSc_ (the Portable, Extensible Toolkit for Scientific
1855a74a43SLisandro Dalcin   Computation) is a suite of data structures and routines for the
1955a74a43SLisandro Dalcin   scalable (parallel) solution of scientific applications modeled by
2055a74a43SLisandro Dalcin   partial differential equations. It employs the MPI_ standard for
2155a74a43SLisandro Dalcin   all message-passing communication.
2255a74a43SLisandro Dalcin
2355a74a43SLisandro Dalcin   This package provides an important subset of PETSc functionalities
2455a74a43SLisandro Dalcin   and uses NumPy_ to efficiently manage input and output of array data.
2555a74a43SLisandro Dalcin
2655a74a43SLisandro Dalcin   A *good friend* of petsc4py is:
2755a74a43SLisandro Dalcin
2855a74a43SLisandro Dalcin      * mpi4py_: Python bindings for MPI_,
2955a74a43SLisandro Dalcin        the *Message Passing Interface*.
3055a74a43SLisandro Dalcin
319690009eSJose E. Roman   Other projects depend on petsc4py:
3255a74a43SLisandro Dalcin
3355a74a43SLisandro Dalcin      * slepc4py_: Python bindings for SLEPc_,
3455a74a43SLisandro Dalcin        the *Scalable Library for Eigenvalue Problem Computations*.
355808f684SSatish Balay
365808f684SSatish Balay.. include:: links.txt
3755a74a43SLisandro Dalcin
3855a74a43SLisandro Dalcin
3955a74a43SLisandro Dalcin.. toctree::
4055a74a43SLisandro Dalcin   :caption: Contents
4155a74a43SLisandro Dalcin   :maxdepth: 2
4255a74a43SLisandro Dalcin
4355a74a43SLisandro Dalcin   overview
4455a74a43SLisandro Dalcin   install
45*6f336411SStefano Zampini   contributing
46b87ba84aSStefano Zampini   citing
47b87ba84aSStefano Zampini
48b87ba84aSStefano Zampini.. toctree::
49b87ba84aSStefano Zampini   :caption: Python specifics
50b87ba84aSStefano Zampini   :maxdepth: 2
51b87ba84aSStefano Zampini
52b87ba84aSStefano Zampini   reference
53b87ba84aSStefano Zampini   petsc_python_types
54b87ba84aSStefano Zampini   petsc_options
55b87ba84aSStefano Zampini   demo/demo
5655a74a43SLisandro Dalcin   documentation_standards
57