You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: INSTALL.md
+21-37Lines changed: 21 additions & 37 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ Download this file as a PDF document
17
17
*[OS X]
18
18
*[Windows]
19
19
*[Linux]
20
-
*[Building from Source]
20
+
*[Advanced Installation from Source]
21
21
*[Prerequisites]
22
22
*[CMake]
23
23
*[Make]
@@ -39,7 +39,7 @@ cd opencoarrays
39
39
```
40
40
41
41
Before installing OpenCoarrays, the above bash script will attempt to detect the presence
42
-
of the default prequisite packages: [GCC], [MPICH] , and [CMake]. If any of the
42
+
of the default prequisite packages: [GCC], [MPICH] , and [CMake]. For additional details, see the [Prerequisites] section. If any of the
43
43
aforementioned packages appear to be absent from the user's PATH environment variable,
44
44
the [install.sh] script will attempt to download, build, and install any missing packages
45
45
after asking permission to do so. The script has been tested on Linux and OS X. Please
@@ -106,41 +106,27 @@ for the relevant Linux distribution. Alternatively, if you desire to install us
106
106
Linux package management software such as [yum] or [apt-get], please submit a feature
107
107
request via our [Issues] page.
108
108
109
-
Building from source
109
+
Advanced Installation from Source
110
110
--------------------
111
111
112
112
### Prerequisites: ###
113
113
114
-
For broad coverage of CAF features, ease of installation, and ease of use, first
115
-
install the following:
116
-
117
-
* An OpenCoarrays-aware Fortran compiler: currently [GCC] 5.1 or later,
118
-
* The Fortran compiler's companion C compiler that supports the C99 standard, and
119
-
* An MPI implementation that supports MPI 3.0 and is built by the aforementioned
120
-
Fortran and C compilers (preferably the [MPICH] or [MVAPICH] implementations for
121
-
robustness and high performance)
122
-
123
-
The [install_prerequisites] directory contains experimental [buildgcc], [buildmpich], and
124
-
[buildcmake] bash shell scripts that can download and build any one of several versions of the
125
-
[GCC] C, C++, and Fortran compilers; the [CMake] build sytem; and the [MPICH] communication
126
-
library. (Because newer parts of the GNU Fortran compiler gfortran are written in C++,
127
-
installing the GNU Fortran compiler from source requires also installing the GNU C++ compiler
128
-
`g++`.) The CMake scripts that build OpenCoarrays also copy [buildgcc], [buildmpich], and
129
-
[buildcmake] into the `bin` directory of the OpenCoarrays installation for later use.
130
-
131
-
We have tested the build scripts on OS X and Linux. Please submit suggestions for improving
132
-
the scripts to our [Issues] page or preferably suggeste edits by forking a copy of the
133
-
[OpenCoarrays] repository, making the suggested edits, and submitting a pull request.
134
-
135
-
If installing the above prerequisites is infeasible, then a limited coverage of CAF
136
-
features is available via the OpenCoarrays `caf` compiler wrapper and the
137
-
[opencoarrays] module, for which the installation prerequisites are the following:
138
-
139
-
* A Fortran compiler that supports the C-interoperability features of Fortran 2003,
140
-
* The Fortran compiler's companion C compiler that supports the C99 standard, and
141
-
* An MPI implementation that supports MPI 3.0 and is built by the aforementioned
142
-
Fortran and C compilers (preferably the [MPICH] or [MVAPICH] implementations for
143
-
robustness and high performance)
114
+
The following prerequisites and their dependencies are recommended for the broadest coverage of CAF features. The download, compilation and installation of these prerequisites will be automatically attempted by the [install.sh] script, if any of them are missing or outdated.
115
+
116
+
```
117
+
opencoarrays
118
+
├── cmake-3.4.0
119
+
└── mpich-3.1.4
120
+
└── gcc-5.3.0
121
+
├── flex-2.6.0
122
+
│ └── bison-3.0.4
123
+
│ └── m4-1.4.17
124
+
├── gmp
125
+
├── mpc
126
+
└── mpfr
127
+
```
128
+
129
+
If using the advanced [CMake] or [Make] builds detailed below, please ensure that these dependencies are met before attempting to build and install OpenCoarrays.
144
130
145
131
### CMake ###
146
132
@@ -235,7 +221,7 @@ where the second line builds the flex package that is required for building gcc
235
221
[ticket]: https://trac.macports.org/ticket/47806
236
222
[Windows]: #windows
237
223
[Linux]: #linux
238
-
[Building from Source]: #building-from-source
224
+
[Advanced Installation from Source]: #advanced-installation-from-source
239
225
[Prerequisites]: #prerequisites
240
226
[CMake]: #cmake
241
227
[Make]: #make
@@ -250,9 +236,7 @@ where the second line builds the flex package that is required for building gcc
0 commit comments