documentation links broken
Issue #166
resolved
https://bitbucket.org/mpi4py/mpi4py/src/master/docs/index.rst
has 3 links at the top for the User Manual and API hosted on bitbucket. All produce the message “Hmm... can't find that one” when I click on them.
I’m not entirely sure if they are supposed to work since the User Manual seems to be elsewhere. But I can’t find anything that tells me exactly which classes/functions/attributes are defined, with what arguments, and what precisely they are supposed to do.
Comments (2)
-
-
- changed status to resolved
- Log in to comment
The problem is that you are looking at a reStructuredText source auto-redered by Bitbucket, so some link will not work. You should look instead at https://mpi4py.bitbucket.io/
Regarding some API reference, the best I can offer is the one generated with the epydoc tool: https://mpi4py.bitbucket.io/apiref/
Documentation is scarce. Everyone complains, sometimes in a very harsh way, but so far no one has ever contributed anything significant to the core project. Make sure to read the very small tutorial in the user manual. After that, take into account that mpi4py’s API is very close to the MPI bindings for C++ and close enough to the C bindings. mpi4py’s does not reinvent the wheel, so if you know how to code MPI in C and Fortran, moving to Python should be relatively straightforward. If you do not know MPI, then read, code, and learn, I’m not in the business of making beginners’s life easy.
Here you have a good third-party tutorial https://materials.jeremybejarano.com/MPIwithPython/
Write to Victor Eijkhout at TACC asking for his nice MPI/OpenMP book showcasing mpi4py. This book used to be online, but it may be temporarily down now, as Victor is in the process of making some repository changes.