Skip to content

Commit 2c5ee35

Browse files
author
Damian Rouson
authored
Update README.md
1 parent 13f77d5 commit 2c5ee35

File tree

1 file changed

+35
-22
lines changed

1 file changed

+35
-22
lines changed

README.md

Lines changed: 35 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -13,42 +13,53 @@ feedback from testing these features. Unchecked items are insufficiently mature
1313
- [ ] The [issue-#6-iso-fortran-binding-h branch] providing gthe Fortran 2015 `iso_fortran_binding.h` file.
1414

1515
We welcome code contributions via [pull request] for any listed features or other unsupported
16-
features of the draft Fortran 2015 standard:
16+
features of the [draft Fortran 2015 standard]:
1717

1818
Installation
1919
============
20-
This fork's [releases] are produced from the [teams branch], which expect will be of
21-
most interest to users. We recommend building releses usin the [OpenCoarrays]
22-
installation script as follows:
20+
This fork's [releases] are produced from the [teams branch], which we expect will be of
21+
most interest to users. We recommend building the [latest release] using the [OpenCoarrays]
22+
`install.sh` script as follows:
2323
```bash
24+
# Install a teams-branch release of this GCC fork
2425
git clone https://github.com/sourceryinstitute/opencoarrays
2526
cd oppencoarrays
2627
./install.sh --package gcc \
2728
--from-url https://github.com/sourceryinstitute/gcc/archive/<release-tag>.tar.gz \
2829
--install-version <release-tag>
2930
```
30-
where <version-number> and <release-tag> must be replaced with the appropriate strings such as
31-
1.9.2 and teams-20170921, respectively. The final command above peforms the safest but slowest
32-
build, which could take several hours to complete. For a speedier build, add the `--disable-bootstrap`,
33-
which might fail if the GCC you are using to build is too old. Also, for an interactive build,
34-
add `--yes-to-all` to instruct the installer to assume affirmative answers to any queries. If successful,
35-
the above steps will install GCC in the prerequisites/installations subdirectory. To see additional
36-
installation options, including choosing another installation path, execute `./install.sh --help`.
37-
38-
For access to any Fortran 2015 parallel features, including teams and failed images, build the [MPICH]
39-
and the [opencoarrays-teams branch] of OpenCoarrays:
31+
where <release-tag> must be replaced with the appropriate string such as teams-20170921. The final
32+
command above peforms the safest but slowest build, which could take several hours to complete.
33+
For a speedier build, add the `--disable-bootstrap`, which might fail if the GCC you are using
34+
to build is too old. Also, for an interactive build, add `--yes-to-all` to instruct the
35+
installer to assume affirmative answers to any queries. If successful, the above steps will
36+
install GCC in the `prerequisites/installations` subdirectory. To see additional installation
37+
options, including choosing another installation path, execute `./install.sh --help`.
38+
39+
Next use the resulting compilers to build [MPICH] 3.2 or later:
40+
```bash
41+
#Install the teams-branch release of the GCC fork:
42+
./install.sh --package gcc --from-url https://github.com/sourceryinstitute/gcc/teams-<release-tag>
43+
44+
# Install MPICH 3.2 or later using the GCC that was installed above:
45+
export LD_LIBRARY_PATH="${PWD}"/prerequisites/installations/gcc/teams-<release-tag>/lib64
46+
47+
./install.sh --package mpich \
48+
--with-fortran "${PWD}"/prerequisites/installations/gcc/<release-tag>/bin/gfortarn \
49+
--with-c "${PWD}"/prerequisites/installations/gcc/<release-tag>/bin/gcc \
50+
--with-cpp "${PWD}"/prerequisites/installations/gcc/<release-tag>bin/g++
51+
52+
```
53+
54+
Next use the resulting [MPICH] installation to build the [opencoarrays-teams branch] of OpenCoarrays.
4055
```bash
56+
# Install OpenCoarrays using the MPICH just installed:
4157
git checkout opencoarrays-teams
42-
export LD_LIBRARY_PATH=<gcc-fork-install-path>/lib64:$LD_LIBRARY_PATH
43-
./install.sh --package mpich \
44-
--with-fortran <gcc-fork-install-path>/bin/gfortarn \
45-
--with-c <gcc-fork-install-path>/bin/gcc \
46-
--with-cpp <gcc-fork-install-path>/bin/g++
4758
./install.sh \
48-
--with-mpi <mpich-install-path>
59+
--with-mpi "${PWD}"/prerequisites/installations/mpich/<mpich-version-number>/
4960
```
50-
with appropriate substitutions for the values between angular brackdets (<...>). Please report
51-
any problems with the above steps on our [issues page].
61+
after again replacin text between angular brackets with the appropriate string (<...>) such as "3.2".
62+
Please report any problems with the above steps on our [issues page].
5263

5364

5465
[GCC mirror] README
@@ -88,3 +99,5 @@ individually.
8899
[issues page]: https://github.com/sourceryinstitute/gcc/issues/
89100
[opencoarrays-teams branch]: https://github.com/sourceryinstitute/opencoarrays/tree/opencoarrays-teams
90101
[pull request]: https://github.com/sourceryinstitute/gcc/pulls
102+
[draft Fortran 2015 standard]: https://bit.ly/fortran-2015-draft
103+
[latest release]: https://github.com/sourceryinstitute/gcc/releases/latest

0 commit comments

Comments
 (0)