Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
eschnett committed Sep 6, 2014
1 parent f78aff1 commit 87097b3
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
23 changes: 11 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,34 @@
# MPI interface for the Julia language

This is a basic [Julia] wrapper for the portable message passing system
Message Passing Interface ([MPI]). Inspiration is taken from [mpi4py].
This is a basic [Julia] wrapper for the portable message passing
system Message Passing Interface ([MPI]). Inspiration is taken from
mpi4py, although we generally follow the C and not the C++ MPI API.
(The C++ MPI API is deprecated.)

## Installing

[CMake] is used to piece together the MPI wrapper. Currently a shared
[CMake] is used to piece together the MPI wrapper. Currently a shared
library MPI installation for C and Fortran is required (tested with
[Open MPI] and [MPICH]). To install MPI.jl
using the Julia packaging system, simply run

[Open MPI] and [MPICH]). To install MPI.jl using the Julia packaging
system, run
```julia
Pkg.update()
Pkg.add("MPI")
```
Alternatively,

```julia
Pkg.clone("https://github.com/lcw/MPI.jl.git")
Pkg.clone("https://github.com/eschnett/MPI.jl.git")
Pkg.build()
```

which will build and install the wrapper into `$HOME/.julia/vX.Y/MPI`.

## Usage

To run a Julia script with MPI, first make sure that `using MPI` or
`import MPI` is included at the top of your script. You should then be able
to run the MPI job as expected, e.g., with
`import MPI` is included at the top of your script. You should then be
able to run the MPI job as expected, e.g., with

mpirun -np 3 julia 01-hello.jl
mpirun -np 3 julia 01-hello.jl

[Julia]: http://julialang.org/
[MPI]: http://www.mpi-forum.org/
Expand Down
3 changes: 2 additions & 1 deletion UNLICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
This is free and unencumbered software released into the public domain.
This is free and unencumbered software released into the public
domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
Expand Down

0 comments on commit 87097b3

Please sign in to comment.