Open MPI logo

Docs Mailing List Archives

  |   Home   |   Support   |   FAQ   |   all Docs mailing list

Subject: [OMPI docs] Jump starting the Open MPI documentation project
From: Kelly Black (kjblack_at_[hidden])
Date: 2013-09-17 17:59:09


Hello,

I have briefly spoken with Jeff Squyres and Joshua Hersey about the Open
MPI documentation project. Based on feedback from them a rough draft of an
outline has been created. Open MPI is a great resource, and it can benefit
from a central resource that describes how to use it. There is a lot of
information out there, but it can be difficult to find.

I will attach a copy of the current document here. It is quite rough, and
the important thing at this point is the outline that can be found at the
beginning of the document. In terms of the big picture the opening chapter
should contain a broad overview but should also offer a quick start guide
that gives a basic introduction on how to compile and run a program as well
as perform some very basic tasks.

The thinking on the other chapters is that they will be more focused and
provide documentation that ranges from basic, intermediate and advanced
usage of the Open MPI library.

The files are written in LaTeX, and they can be found at
https://github.com/open-mpi/docs The document that is attached here was
made from the development branch. At this point there is not much in the
master branch.

Again, the document is rough and needs more thought. Insights and ideas at
this point are welcome.

Sincerely,
kel
_______________________________________________________
Kelly Black Phone: (315) 600-8334
Clarkson University Fax: (315) 268-2371
Department of Math. & C.S.
PO Box 5815
Potsdam, NY 13699-5815
USA