Skip to content

Commit a955337

Browse files
committed
doc(README): build instructions for more compilers
1 parent 313e5e6 commit a955337

File tree

1 file changed

+33
-10
lines changed

1 file changed

+33
-10
lines changed

README.md

Lines changed: 33 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -60,26 +60,21 @@ Downloading, Building, and Running Examples
6060
Assert was developed primarily with `gfortran` 11.2.0 and `nagfor` 7.1.
6161
Recent versions of the Cray and Intel compilers should also suffice.
6262

63-
### Downloading, building, and testing
64-
65-
#### Downloading Assert
63+
### Downloading Assert
6664
```
6765
git clone [email protected]:sourceryinstitute/assert
6866
cd assert
6967
```
7068

71-
#### Building and testing: single-image (serial) execution
69+
### Building and testing with `gfortran`
70+
#### Single-image (serial) execution
7271
The following command builds Assert and runs the full test suite in a single image:
7372
```
7473
fpm test
7574
```
7675
where `fpm test` builds the Assert library and runs the test suite, including the tests.
77-
To build with the Numerical Algorithms Group (NAG) Fortran compiler, use
78-
```
79-
fpm test --compiler nagfor --flag -fpp
80-
```
8176

82-
#### Building and testing: multi-image (parallel) execution
77+
#### Multi-image (parallel) execution
8378
With `gfortran` and OpenCoarrays installed,
8479
```
8580
fpm test --compiler caf --runner "cafrun -n 2"
@@ -90,7 +85,35 @@ To build and test with the Numerical Algorithms Group (NAG) Fortran compiler ver
9085
fpm test --compiler=nagfor --flag="-coarray=cosmp -fpp -f2018"
9186
```
9287

93-
For documentation on using Assert with other compilers, please submit an issue or pull request.
88+
### Building and testing with the Intel `ifx` compiler
89+
```
90+
fpm test --compiler ifx --flag -coarray
91+
```
92+
93+
### Building and testing with the Numerical Algorithms Group (NAG) compiler
94+
```
95+
fpm test --compiler nagfor --flag "-fpp -coarray=cosmp"
96+
```
97+
98+
### Building and testing with the Cray Compiler Environment (CCE)
99+
Because `fpm` uses the compiler name to determine the compiler identity and because
100+
CCE provides one compiler wrapper, `ftn`, for invoking all compilers, you will
101+
need to invoke `ftn` in a shell script named to identify CCE compiler. For example,
102+
place a script named `crayftn.sh` in your path with the following contents and with
103+
executable privileges set appropriately:
104+
```
105+
#!/bin/bash
106+
107+
ftn $@
108+
```
109+
Then build and test Assert with the command
110+
```
111+
fpm test --compiler crayftn.sh
112+
```
113+
114+
115+
### Building and testing with the Cray Compiler Environment (CCE)
116+
To use Assert with other compilers, please submit an issue or pull request.
94117

95118
### Running the examples
96119
See the [./example](./example) subdirectory.

0 commit comments

Comments
 (0)