xref: /petsc/src/binding/petsc4py/docs/index.rst (revision 69f65dfb176f3d3e756fc44d2300fd6791726976)
1================
2PETSc for Python
3================
4
5:Author:       Lisandro Dalcin
6:Contact:      dalcinl@gmail.com
7
8
9Online Documentation
10--------------------
11
12+ `User Manual (HTML)`_ (generated with Sphinx_).
13+ `User Manual (PDF)`_  (generated with Sphinx_).
14+ `API Reference`_      (generated with Epydoc_).
15
16.. _User Manual (HTML): usrman/index.html
17.. _User Manual (PDF):  petsc4py.pdf
18.. _API Reference:      apiref/index.html
19
20.. _Sphinx:    https://www.sphinx-doc.org/
21.. _Epydoc:    https://epydoc.sourceforge.net/
22
23
24Discussion and Support
25----------------------
26
27+ Mailing Lists: petsc-users@mcs.anl.gov, petsc-dev@mcs.anl.gov
28
29
30Downloads and Development
31-------------------------
32
33+ Issue Tracker:  https://gitlab.com/petsc/petsc/-/issues
34+ Git Repository: https://gitlab.com/petsc/petsc.git
35+ The source code is in ``src/binding/petsc4py``
36+ Previous source releases: https://pypi.org/project/petsc4py/
37
38Citations
39---------
40
41If PETSc for Python been significant to a project that leads to an
42academic publication, please acknowledge that fact by citing the
43project.
44
45* L. Dalcin, P. Kler, R. Paz, and A. Cosimo,
46  *Parallel Distributed Computing using Python*,
47  Advances in Water Resources, 34(9):1124-1139, 2011.
48  http://dx.doi.org/10.1016/j.advwatres.2011.04.013
49
50* S. Balay, S. Abhyankar, M. Adams,
51  J. Brown, P. Brune, K. Buschelman,
52  L. Dalcin, A. Dener, V. Eijkhout, W. Gropp,
53  D. Karpeyev, D. Kaushik, M. Knepley,
54  D. May, L. Curfman McInnes, R. Mills, T. Munson,
55  K. Rupp, P. Sanan, B. Smith,
56  S. Zampini, H. Zhang, and H. Zhang,
57  *PETSc Users Manual*, ANL-95/11 - Revision 3.17, 2022.
58  https://petsc.org/release/docs/manual
59
60
61Acknowledgments
62---------------
63
64This project was partially supported by the
65Extreme Computing Research Center (ECRC),
66Division of Computer, Electrical, and
67Mathematical Sciences & Engineering (CEMSE),
68King Abdullah University of Science and Technology (KAUST).
69