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