xref: /petsc/src/binding/petsc4py/README.rst (revision f46a955babf5119406b7365221263e26671fb65d)
15808f684SSatish Balay================
25808f684SSatish BalayPETSc for Python
35808f684SSatish Balay================
45808f684SSatish Balay
55808f684SSatish BalayOverview
65808f684SSatish Balay--------
75808f684SSatish Balay
85808f684SSatish BalayWelcome to PETSc for Python. This package provides Python bindings for
95808f684SSatish BalayPETSc_, the *Portable, Extensible Toolkit for Scientific Computation*.
105808f684SSatish Balay
115808f684SSatish BalayDependencies
125808f684SSatish Balay------------
135808f684SSatish Balay
145808f684SSatish Balay* Python_ 2.7, 3.3 or above.
155808f684SSatish Balay
165808f684SSatish Balay* A recent NumPy_ release.
175808f684SSatish Balay
18*f46a955bSLisandro Dalcin* A matching version of PETSc_ built with *shared/dynamic libraries*.
19*f46a955bSLisandro Dalcin
205808f684SSatish Balay* To work with the in-development version, you need Cython_.
215808f684SSatish Balay
22*f46a955bSLisandro Dalcin.. _Python: https://www.python.org
23*f46a955bSLisandro Dalcin.. _NumPy:  https://www.numpy.org
24*f46a955bSLisandro Dalcin.. _PETSc:  https://petsc.org
25*f46a955bSLisandro Dalcin.. _Cython: https://www.cython.org
265808f684SSatish Balay
275808f684SSatish BalayDocumentation
285808f684SSatish Balay-------------
295808f684SSatish Balay
30*f46a955bSLisandro Dalcin* https://petsc4py.readthedocs.org/, This does not contain the epydoc-generated API reference.
315808f684SSatish Balay
32*f46a955bSLisandro Dalcin* https://www.mcs.anl.gov/petsc/petsc4py-current/docs/, This is for the last release, not the in-development version.
33