xref: /petsc/src/binding/petsc4py/docs/index.rst (revision efbe7e8a80d07327753dbe0b33efee01e046af3f)
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:    http://sphinx.pocoo.org/
21.. _Epydoc:    http://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+ Project Site:    https://gitlab.com/petsc/petsc4py
34+ Source Releases: https://gitlab.com/petsc/petsc4py/-/releases
35+ Issue Tracker:   https://gitlab.com/petsc/petsc4py/-/issues
36+ Git Repository:  https://gitlab.com/petsc/petsc4py.git
37
38
39Citations
40---------
41
42If PETSc for Python been significant to a project that leads to an
43academic publication, please acknowledge that fact by citing the
44project.
45
46* L. Dalcin, P. Kler, R. Paz, and A. Cosimo,
47  *Parallel Distributed Computing using Python*,
48  Advances in Water Resources, 34(9):1124-1139, 2011.
49  http://dx.doi.org/10.1016/j.advwatres.2011.04.013
50
51* S. Balay, S. Abhyankar, M. Adams,
52  J. Brown, P. Brune, K. Buschelman,
53  L. Dalcin, A. Dener, V. Eijkhout, W. Gropp,
54  D. Karpeyev, D. Kaushik, M. Knepley,
55  D. May, L. Curfman McInnes, R. Mills, T. Munson,
56  K. Rupp, P. Sanan, B. Smith,
57  S. Zampini, H. Zhang, and H. Zhang,
58  *PETSc Users Manual*, ANL-95/11 - Revision 3.14, 2020.
59  http://www.mcs.anl.gov/petsc/petsc-current/docs/manual.pdf
60
61
62Acknowledgments
63---------------
64
65This project was partially supported by the
66Extreme Computing Research Center (ECRC),
67Division of Computer, Electrical, and
68Mathematical Sciences & Engineering (CEMSE),
69King Abdullah University of Science and Technology (KAUST).
70