build based on 4ba36fa

dev/configuration/index.html

@@ -17,4 +17,4 @@
 julia> MPIPreferences.use_system_binary()
 ~/MPI> rm test/Manifest.toml
 ~/MPI> julia --project
-(MPI) pkg&gt; test</code></pre><h3 id="Environment-variables"><a class="docs-heading-anchor" href="#Environment-variables">Environment variables</a><a id="Environment-variables-1"></a><a class="docs-heading-anchor-permalink" href="#Environment-variables" title="Permalink"></a></h3><p>The test suite can also be modified by the following variables:</p><ul><li><code>JULIA_MPI_TEST_NPROCS</code>: How many ranks to use within the tests</li><li><code>JULIA_MPI_TEST_ARRAYTYPE</code>: Set to <code>CuArray</code> or <code>ROCArray</code> to test the CUDA-aware interface with <a href="https://github.com/JuliaGPU/CUDA.jl"><code>CUDA.CuArray</code></a> or the ROCm-aware interface with <a href="https://github.com/JuliaGPU/AMDGPU.jl"><code>AMDGPU.ROCArray</code></a> or buffers.</li><li><code>JULIA_MPI_TEST_BINARY</code>: Check that the specified MPI binary is used for the tests</li><li><code>JULIA_MPI_TEST_ABI</code>: Check that the specified MPI ABI is used for the tests</li></ul><h2 id="Migration-from-MPI.jl-v0.19-or-earlier"><a class="docs-heading-anchor" href="#Migration-from-MPI.jl-v0.19-or-earlier">Migration from MPI.jl v0.19 or earlier</a><a id="Migration-from-MPI.jl-v0.19-or-earlier-1"></a><a class="docs-heading-anchor-permalink" href="#Migration-from-MPI.jl-v0.19-or-earlier" title="Permalink"></a></h2><p>For MPI.jl v0.20, environment variables were used to configure which MPI library to use. These have been removed and no longer have any effect. The following subsections explain how to the same effects can be achieved with v0.20 or later.</p><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>Please refer to <a href="#Notes-to-HPC-cluster-administrators">Notes to HPC cluster administrators</a> if you want to migrate your MPI.jl preferences on a cluster with a centrally managed MPI.jl configuration.</p></div></div><h3 id="JULIA_MPI_BINARY"><a class="docs-heading-anchor" href="#JULIA_MPI_BINARY"><code>JULIA_MPI_BINARY</code></a><a id="JULIA_MPI_BINARY-1"></a><a class="docs-heading-anchor-permalink" href="#JULIA_MPI_BINARY" title="Permalink"></a></h3><p>Use <a href="../reference/mpipreferences/#MPIPreferences.use_system_binary"><code>MPIPreferences.use_system_binary</code></a> to use a system-provided MPI binary as described <a href="#configure_system_binary">here</a>. To switch back or select a different JLL-provided MPI binary, use <a href="../reference/mpipreferences/#MPIPreferences.use_jll_binary"><code>MPIPreferences.use_jll_binary</code></a> as described <a href="#configure_jll_binary">here</a>.</p><h3 id="JULIA_MPI_PATH"><a class="docs-heading-anchor" href="#JULIA_MPI_PATH"><code>JULIA_MPI_PATH</code></a><a id="JULIA_MPI_PATH-1"></a><a class="docs-heading-anchor-permalink" href="#JULIA_MPI_PATH" title="Permalink"></a></h3><p>Removed without replacement.</p><h3 id="JULIA_MPI_LIBRARY"><a class="docs-heading-anchor" href="#JULIA_MPI_LIBRARY"><code>JULIA_MPI_LIBRARY</code></a><a id="JULIA_MPI_LIBRARY-1"></a><a class="docs-heading-anchor-permalink" href="#JULIA_MPI_LIBRARY" title="Permalink"></a></h3><p>Use <a href="../reference/mpipreferences/#MPIPreferences.use_system_binary"><code>MPIPreferences.use_system_binary</code></a> with keyword argument <code>library_names</code> to specify possible, non-standard library names. Alternatively, you can also specify the full path to the library.</p><h3 id="JULIA_MPI_ABI"><a class="docs-heading-anchor" href="#JULIA_MPI_ABI"><code>JULIA_MPI_ABI</code></a><a id="JULIA_MPI_ABI-1"></a><a class="docs-heading-anchor-permalink" href="#JULIA_MPI_ABI" title="Permalink"></a></h3><p>Use <a href="../reference/mpipreferences/#MPIPreferences.use_system_binary"><code>MPIPreferences.use_system_binary</code></a> with keyword argument <code>abi</code> to specify which ABI to use. See <a href="../reference/mpipreferences/#MPIPreferences.abi"><code>MPIPreferences.abi</code></a> for possible values.</p><h3 id="JULIA_MPIEXEC"><a class="docs-heading-anchor" href="#JULIA_MPIEXEC"><code>JULIA_MPIEXEC</code></a><a id="JULIA_MPIEXEC-1"></a><a class="docs-heading-anchor-permalink" href="#JULIA_MPIEXEC" title="Permalink"></a></h3><p>Use <a href="../reference/mpipreferences/#MPIPreferences.use_system_binary"><code>MPIPreferences.use_system_binary</code></a> with keyword argument <code>mpiexec</code> to specify the MPI launcher executable.</p><h3 id="JULIA_MPIEXEC_ARGS"><a class="docs-heading-anchor" href="#JULIA_MPIEXEC_ARGS"><code>JULIA_MPIEXEC_ARGS</code></a><a id="JULIA_MPIEXEC_ARGS-1"></a><a class="docs-heading-anchor-permalink" href="#JULIA_MPIEXEC_ARGS" title="Permalink"></a></h3><p>Use <a href="../reference/mpipreferences/#MPIPreferences.use_system_binary"><code>MPIPreferences.use_system_binary</code></a> with keyword argument <code>mpiexec</code>, and pass a <a href="https://docs.julialang.org/en/v1/manual/running-external-programs/#Cmd-Objects"><code>Cmd</code></a> object to set the MPI launcher executable and to include specific command line options.</p><h3 id="JULIA_MPI_INCLUDE_PATH"><a class="docs-heading-anchor" href="#JULIA_MPI_INCLUDE_PATH"><code>JULIA_MPI_INCLUDE_PATH</code></a><a id="JULIA_MPI_INCLUDE_PATH-1"></a><a class="docs-heading-anchor-permalink" href="#JULIA_MPI_INCLUDE_PATH" title="Permalink"></a></h3><p>Removed without replacement. Automatic generation of a constants file for unknown MPI ABIs is not supported anymore. See also <a href="https://github.com/JuliaParallel/MPI.jl/issues/574">#574</a>.</p><h3 id="JULIA_MPI_CFLAGS"><a class="docs-heading-anchor" href="#JULIA_MPI_CFLAGS"><code>JULIA_MPI_CFLAGS</code></a><a id="JULIA_MPI_CFLAGS-1"></a><a class="docs-heading-anchor-permalink" href="#JULIA_MPI_CFLAGS" title="Permalink"></a></h3><p>Removed without replacement. Automatic generation of a constants file for unknown MPI ABIs is not supported anymore. See also <a href="https://github.com/JuliaParallel/MPI.jl/issues/574">#574</a>.</p><h3 id="JULIA_MPICC"><a class="docs-heading-anchor" href="#JULIA_MPICC"><code>JULIA_MPICC</code></a><a id="JULIA_MPICC-1"></a><a class="docs-heading-anchor-permalink" href="#JULIA_MPICC" title="Permalink"></a></h3><p>Removed without replacement. Automatic generation of a constants file for unknown MPI ABIs is not supported anymore. See also <a href="https://github.com/JuliaParallel/MPI.jl/issues/574">#574</a>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« MPI.jl</a><a class="docs-footer-nextpage" href="../usage/">Usage »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.24 on <span class="colophon-date" title="Tuesday 13 June 2023 20:34">Tuesday 13 June 2023</span>. Using Julia version 1.9.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+(MPI) pkg&gt; test</code></pre><h3 id="Environment-variables"><a class="docs-heading-anchor" href="#Environment-variables">Environment variables</a><a id="Environment-variables-1"></a><a class="docs-heading-anchor-permalink" href="#Environment-variables" title="Permalink"></a></h3><p>The test suite can also be modified by the following variables:</p><ul><li><code>JULIA_MPI_TEST_NPROCS</code>: How many ranks to use within the tests</li><li><code>JULIA_MPI_TEST_ARRAYTYPE</code>: Set to <code>CuArray</code> or <code>ROCArray</code> to test the CUDA-aware interface with <a href="https://github.com/JuliaGPU/CUDA.jl"><code>CUDA.CuArray</code></a> or the ROCm-aware interface with <a href="https://github.com/JuliaGPU/AMDGPU.jl"><code>AMDGPU.ROCArray</code></a> or buffers.</li><li><code>JULIA_MPI_TEST_BINARY</code>: Check that the specified MPI binary is used for the tests</li><li><code>JULIA_MPI_TEST_ABI</code>: Check that the specified MPI ABI is used for the tests</li></ul><h2 id="Migration-from-MPI.jl-v0.19-or-earlier"><a class="docs-heading-anchor" href="#Migration-from-MPI.jl-v0.19-or-earlier">Migration from MPI.jl v0.19 or earlier</a><a id="Migration-from-MPI.jl-v0.19-or-earlier-1"></a><a class="docs-heading-anchor-permalink" href="#Migration-from-MPI.jl-v0.19-or-earlier" title="Permalink"></a></h2><p>For MPI.jl v0.20, environment variables were used to configure which MPI library to use. These have been removed and no longer have any effect. The following subsections explain how to the same effects can be achieved with v0.20 or later.</p><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>Please refer to <a href="#Notes-to-HPC-cluster-administrators">Notes to HPC cluster administrators</a> if you want to migrate your MPI.jl preferences on a cluster with a centrally managed MPI.jl configuration.</p></div></div><h3 id="JULIA_MPI_BINARY"><a class="docs-heading-anchor" href="#JULIA_MPI_BINARY"><code>JULIA_MPI_BINARY</code></a><a id="JULIA_MPI_BINARY-1"></a><a class="docs-heading-anchor-permalink" href="#JULIA_MPI_BINARY" title="Permalink"></a></h3><p>Use <a href="../reference/mpipreferences/#MPIPreferences.use_system_binary"><code>MPIPreferences.use_system_binary</code></a> to use a system-provided MPI binary as described <a href="#configure_system_binary">here</a>. To switch back or select a different JLL-provided MPI binary, use <a href="../reference/mpipreferences/#MPIPreferences.use_jll_binary"><code>MPIPreferences.use_jll_binary</code></a> as described <a href="#configure_jll_binary">here</a>.</p><h3 id="JULIA_MPI_PATH"><a class="docs-heading-anchor" href="#JULIA_MPI_PATH"><code>JULIA_MPI_PATH</code></a><a id="JULIA_MPI_PATH-1"></a><a class="docs-heading-anchor-permalink" href="#JULIA_MPI_PATH" title="Permalink"></a></h3><p>Removed without replacement.</p><h3 id="JULIA_MPI_LIBRARY"><a class="docs-heading-anchor" href="#JULIA_MPI_LIBRARY"><code>JULIA_MPI_LIBRARY</code></a><a id="JULIA_MPI_LIBRARY-1"></a><a class="docs-heading-anchor-permalink" href="#JULIA_MPI_LIBRARY" title="Permalink"></a></h3><p>Use <a href="../reference/mpipreferences/#MPIPreferences.use_system_binary"><code>MPIPreferences.use_system_binary</code></a> with keyword argument <code>library_names</code> to specify possible, non-standard library names. Alternatively, you can also specify the full path to the library.</p><h3 id="JULIA_MPI_ABI"><a class="docs-heading-anchor" href="#JULIA_MPI_ABI"><code>JULIA_MPI_ABI</code></a><a id="JULIA_MPI_ABI-1"></a><a class="docs-heading-anchor-permalink" href="#JULIA_MPI_ABI" title="Permalink"></a></h3><p>Use <a href="../reference/mpipreferences/#MPIPreferences.use_system_binary"><code>MPIPreferences.use_system_binary</code></a> with keyword argument <code>abi</code> to specify which ABI to use. See <a href="../reference/mpipreferences/#MPIPreferences.abi"><code>MPIPreferences.abi</code></a> for possible values.</p><h3 id="JULIA_MPIEXEC"><a class="docs-heading-anchor" href="#JULIA_MPIEXEC"><code>JULIA_MPIEXEC</code></a><a id="JULIA_MPIEXEC-1"></a><a class="docs-heading-anchor-permalink" href="#JULIA_MPIEXEC" title="Permalink"></a></h3><p>Use <a href="../reference/mpipreferences/#MPIPreferences.use_system_binary"><code>MPIPreferences.use_system_binary</code></a> with keyword argument <code>mpiexec</code> to specify the MPI launcher executable.</p><h3 id="JULIA_MPIEXEC_ARGS"><a class="docs-heading-anchor" href="#JULIA_MPIEXEC_ARGS"><code>JULIA_MPIEXEC_ARGS</code></a><a id="JULIA_MPIEXEC_ARGS-1"></a><a class="docs-heading-anchor-permalink" href="#JULIA_MPIEXEC_ARGS" title="Permalink"></a></h3><p>Use <a href="../reference/mpipreferences/#MPIPreferences.use_system_binary"><code>MPIPreferences.use_system_binary</code></a> with keyword argument <code>mpiexec</code>, and pass a <a href="https://docs.julialang.org/en/v1/manual/running-external-programs/#Cmd-Objects"><code>Cmd</code></a> object to set the MPI launcher executable and to include specific command line options.</p><h3 id="JULIA_MPI_INCLUDE_PATH"><a class="docs-heading-anchor" href="#JULIA_MPI_INCLUDE_PATH"><code>JULIA_MPI_INCLUDE_PATH</code></a><a id="JULIA_MPI_INCLUDE_PATH-1"></a><a class="docs-heading-anchor-permalink" href="#JULIA_MPI_INCLUDE_PATH" title="Permalink"></a></h3><p>Removed without replacement. Automatic generation of a constants file for unknown MPI ABIs is not supported anymore. See also <a href="https://github.com/JuliaParallel/MPI.jl/issues/574">#574</a>.</p><h3 id="JULIA_MPI_CFLAGS"><a class="docs-heading-anchor" href="#JULIA_MPI_CFLAGS"><code>JULIA_MPI_CFLAGS</code></a><a id="JULIA_MPI_CFLAGS-1"></a><a class="docs-heading-anchor-permalink" href="#JULIA_MPI_CFLAGS" title="Permalink"></a></h3><p>Removed without replacement. Automatic generation of a constants file for unknown MPI ABIs is not supported anymore. See also <a href="https://github.com/JuliaParallel/MPI.jl/issues/574">#574</a>.</p><h3 id="JULIA_MPICC"><a class="docs-heading-anchor" href="#JULIA_MPICC"><code>JULIA_MPICC</code></a><a id="JULIA_MPICC-1"></a><a class="docs-heading-anchor-permalink" href="#JULIA_MPICC" title="Permalink"></a></h3><p>Removed without replacement. Automatic generation of a constants file for unknown MPI ABIs is not supported anymore. See also <a href="https://github.com/JuliaParallel/MPI.jl/issues/574">#574</a>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« MPI.jl</a><a class="docs-footer-nextpage" href="../usage/">Usage »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Tuesday 18 July 2023 15:39">Tuesday 18 July 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/examples/01-hello/index.html

@@ -6,7 +6,7 @@
 comm = MPI.COMM_WORLD
 print("Hello world, I am rank $(MPI.Comm_rank(comm)) of $(MPI.Comm_size(comm))\n")
 MPI.Barrier(comm)</code></pre><pre><code class="nohighlight hljs">&gt; mpiexecjl -n 4 julia examples/01-hello.jl
-Hello world, I am rank 1 of 4
+Hello world, I am rank 3 of 4
 Hello world, I am rank 0 of 4
-Hello world, I am rank 2 of 4
-Hello world, I am rank 3 of 4</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../knownissues/">« Known issues</a><a class="docs-footer-nextpage" href="../02-broadcast/">Broadcast »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.24 on <span class="colophon-date" title="Tuesday 13 June 2023 20:34">Tuesday 13 June 2023</span>. Using Julia version 1.9.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+Hello world, I am rank 1 of 4
+Hello world, I am rank 2 of 4</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../knownissues/">« Known issues</a><a class="docs-footer-nextpage" href="../02-broadcast/">Broadcast »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Tuesday 18 July 2023 15:39">Tuesday 18 July 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>