Skip to content

Commit 81d4b87

Browse files
committed
Add Windows specifics to README.md
1 parent 82ba31c commit 81d4b87

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ mpi4py, although we generally follow the C and not the C++ MPI API.
1010

1111
## Installing
1212

13+
### Unix systems (OSX and Linux)
14+
1315
[CMake] is used to piece together the MPI wrapper. Currently a shared
1416
library MPI installation for C and Fortran is required (tested with
1517
[Open MPI] and [MPICH]). To install MPI.jl using the Julia packaging
@@ -28,7 +30,7 @@ which will build and install the wrapper into `$HOME/.julia/vX.Y/MPI`.
2830
#### Platform specific notes:
2931
* If you are trying to build on OSX with Homebrew, the necessary Fortran headers are not included in the OpenMPI bottle. To workaround this you can build OpenMPI from source: `brew install --build-from-source openmpi`
3032

31-
### Overriding the auto-detected MPI version
33+
#### Overriding the auto-detected MPI version
3234

3335
It may be that CMake selects the wrong MPI version, or that CMake
3436
fails to correctly detect and configure your MPI implementation. You
@@ -65,6 +67,15 @@ MPI_INCLUDE_PATH
6567
MPI_LIBRARIES
6668
```
6769

70+
### Windows
71+
72+
You need to install the [Microsoft MPI](https://www.microsoft.com/en-us/download/details.aspx?id=49926) runtime on your system (the SDK is not required). Then simply add the MPI.jl package with
73+
74+
```julia
75+
Pkg.update()
76+
Pkg.add("MPI")
77+
```
78+
6879
## Usage : MPI-Only mode
6980

7081
To run a Julia script with MPI, first make sure that `using MPI` or

0 commit comments

Comments
 (0)