Skip to content

Commit 17890a6

Browse files
authored
Merge pull request #73 from sourceryinstitute/update-readme
doc(README): add build/test info for CCE & NAG
2 parents 395d677 + f8e3da0 commit 17890a6

File tree

1 file changed

+39
-5
lines changed

1 file changed

+39
-5
lines changed

README.md

Lines changed: 39 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -74,18 +74,52 @@ See [fpm manifest](./fpm.toml) for the dependencies and developer dependencies,
7474
that [fpm] automatically downloads and builds via the `fpm` command provided in
7575
the "[Downloding, Building, and Testing]" section below.
7676

77+
Downloding
78+
----------
79+
```zsh
80+
git clone [email protected]:sourceryinstitute/sourcery
81+
```
7782

78-
Downloding, Building, and Testing
79-
---------------------------------
83+
Building and Testing
84+
--------------------
85+
### Single-image (serial) testing with GNU Fortran (`gfortran`)
8086
With recent versions of [GNU Fortran] (gfortran) and [OpenCoarrays] installed,
8187
execute the following command in a `zsh` or `bash`-like shell:
88+
```zsh
89+
fpm test
90+
```
8291

92+
### Multi-image (parallel) testing with `gfortran` and OpenCoarrays
93+
With recent versions of [GNU Fortran] (gfortran) and [OpenCoarrays] installed,
94+
execute the following command in a `zsh` or `bash`-like shell:
8395
```zsh
84-
git clone [email protected]:sourceryinstitute/sourcery
8596
fpm test --compiler caf --runner "cafrun -n 4"
86-
8797
```
88-
substituting the number of desired images for the "4" above.
98+
Substitute the desired number of images for the `4` above.
99+
100+
### Testing with the Numerical Algorithms Group (`nagfor`) compiler
101+
```zsh
102+
fpm test --compiler nagfor --flag "-fpp -coarray=cosmp"
103+
```
104+
105+
### Building and testing with the Cray Compiler Environment (CCE)
106+
Because `fpm` uses the compiler name to determine the compiler identity and because
107+
CCE provides one compiler wrapper, `ftn`, for invoking all compilers, you will
108+
need to invoke `ftn` in a shell script named to identify CCE compiler. For example,
109+
place a script named `crayftn.sh` in your path with the following contents and with
110+
executable privileges set appropriately:
111+
```
112+
#!/bin/bash
113+
114+
ftn $@
115+
```
116+
Then build and test Sourcery with the command
117+
```
118+
fpm test --compiler crayftn.sh
119+
```
120+
121+
### Building and testing with other compilers
122+
To use Sourcery with other compilers, please submit an issue or pull request.
89123

90124
Building the documentation
91125
--------------------------

0 commit comments

Comments
 (0)