Subject: Re: [OMPI docs] Jump starting the Open MPI documentation project
From: Jeff Squyres (jsquyres) (jsquyres_at_[hidden])
Date: 2013-09-20 21:10:59
+1 on this: documenting the OMPI particulars would be a good way to go.
That being said, if documenting basic MPI usage is of interest, that would also be fine - but I'd cleanly separate it from the OMPI particulars. For example, the first chapter can be an overview of OMPI particulars (installation, compiling MPI applications, mpirun and friends, etc.), and then use that knowledge in a more in-depth set of MPI programming tutorials.
On Sep 18, 2013, at 12:29 PM, Ralph Castain <rhc_at_[hidden]> wrote:
> I assume you are documenting how to run MPI programs based on OMPI as opposed to how to develop code inside of OMPI?
>
> The attached looks like you are targeting the former. There are many good books on MPI programming that explain in depth how to write and execute MPI programs, so I wouldn't bother explaining things like MPI_Init.
>
> I would instead focus on providing details on all the OMPI options, which go beyond basic MPI programming and can be confusing to users. You'd have to present a breakdown of how OMPI is structured as a way of introducing the MCA param naming scheme, and then discuss what those params actually do, when to use them, etc.
>
> HTH
> Ralph
>
> On Sep 17, 2013, at 2:59 PM, Kelly Black <kjblack_at_[hidden]> wrote:
>
>> 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
>> <OpenMPIUserManual.pdf>_______________________________________________
>> docs mailing list
>> docs_at_[hidden]
>> http://www.open-mpi.org/mailman/listinfo.cgi/docs
>
> _______________________________________________
> docs mailing list
> docs_at_[hidden]
> http://www.open-mpi.org/mailman/listinfo.cgi/docs
-- Jeff Squyres jsquyres_at_[hidden] For corporate legal information go to: http://www.cisco.com/web/about/doing_business/legal/cri/