Skip to content

Commit 79054fc

Browse files
committed
update doc to clarify build procedure & python dependencies
1 parent edc77ea commit 79054fc

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,9 @@ Interface, for building an universal MPI code:
3939

4040
* **GNU/Linux OS**
4141
* **Mandatory**: C and Fortran compilers
42-
* **Optionnal**: Python3 and Jinja2
42+
* **Optional**: Python 3 and Jinja 2
43+
44+
Python 3 is mandatory if you need to generate Wi4MPI code. As specified in the [generator requirements](src/generator/requirements.txt), it depends on `logging`, `colorlog` & `docopts` Python packages.
4345

4446
### Spack
4547

@@ -53,7 +55,8 @@ Check the WI4MPI Spack tutorial here: [Installalling Wi4MPI using Spack](https:/
5355

5456
### Compiling with CMAKE
5557

56-
Here is a quick introduction to WI4MPI compiling, please check the full documentation to see other options.
58+
Here is a quick introduction to compile WI4MPI with pre-generated sources (using `wi4mpi-x.y.z.tar.gz` archive
59+
provided with releases, starting with Wi4MPI 4.0):
5760

5861
```
5962
$ cd build
@@ -62,6 +65,8 @@ $ make -j 16
6265
$ make install
6366
```
6467

68+
For more details (and in particular if you need to regenerate the sources) please check the full documentation.
69+
6570
### Documentation
6671

6772
Wi4MPI documentation is built with `Sphinx`, choose your preferred format.

doc/source/user_guide/installation.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Installation
22
============
33

44
The installation process consists of a standard CMake build and installation sequence.
5-
The release archive contains pre-generated code to simplify the build process.
5+
The release archive contains pre-generated code (`wi4mpi-x.y.z.tar.gz` archive, containing the generated code in `build/`) to simplify the build process. By default, the build process expects this generated sources to be there (`WI4MPI_GENERATOR` is set to `OFF`).
66

77
.. code-block:: bash
88
@@ -47,14 +47,14 @@ The following CMake variables can be used to configure the build:
4747

4848
Specifies the Open MPI header version used during code generation.
4949

50-
**Default:** `1.8.8`
50+
**Default:** `4.1.6`
5151
**Supported versions:** `1.8.8`, `2.1.6`, `4.1.6`, `5.0.3`
5252

5353
- **WI4MPI_GENERATOR_MPICH_VERSION** (*string*)
5454

5555
Specifies the MPICH header version used during code generation.
5656

57-
**Default:** `3.1.2`
57+
**Default:** `3.4.3`
5858
**Supported versions:** `3.1.2`, `3.4.3`, `4.2.0`
5959

6060
- **WI4MPI_GENERATOR_INTELMPI_VERSION** (*string*)

0 commit comments

Comments
 (0)