xref: /petsc/src/binding/petsc4py/DESCRIPTION.rst (revision d0295fc027abbea29f13fa82c19cf92da8e9ba99)
1PETSc for Python
2================
3
4Python bindings for PETSc.
5
6Install
7-------
8
9If you have a working MPI implementation and the ``mpicc`` compiler
10wrapper is on your search path, it highly recommended to install
11``mpi4py`` first::
12
13  $ pip install mpi4py
14
15Ensure you have NumPy installed::
16
17  $ pip install numpy
18
19and finally::
20
21  $ pip install petsc petsc4py
22
23You can also install the in-development version of petsc4py with::
24
25  $ pip install Cython numpy mpi4py
26  $ pip install --no-deps git+https://gitlab.com/petsc/petsc
27  $ pip install --no-deps git+https://gitlab.com/petsc/petsc4py
28
29or::
30
31  $ pip install Cython numpy mpi4py
32  $ pip install --no-deps https://gitlab.com/petsc/petsc/-/archive/master.tar.gz
33  $ pip install --no-deps https://gitlab.com/petsc/petsc4py/-/archive/master.tar.gz
34
35
36Citations
37---------
38
39If PETSc for Python been significant to a project that leads to an
40academic publication, please acknowledge that fact by citing the
41project.
42
43* L. Dalcin, P. Kler, R. Paz, and A. Cosimo,
44  *Parallel Distributed Computing using Python*,
45  Advances in Water Resources, 34(9):1124-1139, 2011.
46  http://dx.doi.org/10.1016/j.advwatres.2011.04.013
47
48* S. Balay, S. Abhyankar, M. Adams,
49  J. Brown, P. Brune, K. Buschelman,
50  L. Dalcin, A. Dener, V. Eijkhout, W. Gropp,
51  D. Karpeyev, D. Kaushik, M. Knepley,
52  D. May, L. Curfman McInnes, R. Mills, T. Munson,
53  K. Rupp, P. Sanan, B. Smith,
54  S. Zampini, H. Zhang, and H. Zhang,
55  *PETSc Users Manual*, ANL-95/11 - Revision 3.14, 2020.
56  http://www.mcs.anl.gov/petsc/petsc-current/docs/manual.pdf
57