summaryrefslogtreecommitdiff
path: root/modules/mpi/help/en_US/mpi.xml
blob: bafec3cebe8aaa9df3a9ddde1632514c01657a0a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2011 - DIGITEO - Sylvestre Ledru
 * 
 * This file must be used under the terms of the CeCILL.
 * This source file is licensed as described in the file COPYING, which
 * you should have received as part of this distribution.  The terms
 * are also available at    
 * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
 *
 -->
<!-- This document was created with Syntext Serna Free. -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="mpi" xml:lang="en">
    <refnamediv>
        <refname>MPI</refname>
        <refpurpose>Access to MPI features from Scilab</refpurpose>
    </refnamediv>
    <refsection>
        <title>Description</title>
        <para>A MPI interface is provided to Scilab. This interface allows high-performance Message Passing computations.</para>
        <para>
            Like any other MPI applications, Scilab/MPI as be started through the <literal>mpirun</literal> command usually with the argument <literal>-c</literal> to specify the number of nodes started.
        </para>
    </refsection>
    <refsection>
        <title>Supported datatype</title>
        <para>
            The Scilab MPI implementation supports the following Scilab datatypes (under the matrix or scalar form):
            <simplelist type="inline">
                <member>Double</member><member>Boolean</member><member>int (all)</member><member>String</member><member>Sparse</member><member>Boolean Sparse</member>
            </simplelist>
            For now, advanced data structures like list, tlist or mlist are not supported. Opening a new bug report to see them supported is a good way.
        </para>
    </refsection>
    <refsection>
        <title>Example of Scilab MPI</title>
        <programlisting role="scilab"><![CDATA[ 
// TODO. Add an example (PI ?)

]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="MPI_Recv">MPI_Recv</link>
            </member>
            <member>
                <link linkend="mpi_technical">Technical details about the implementation</link>
            </member>
        </simplelist>
    </refsection>
</refentry>