Skip to content

Commit 9b43112

Browse files
author
sourceryinstitute
committed
Update installation instructions
Directing OS X users to the virtual machine until the Macports Portfile has been accepted. Also pointing users to the new GCC and MPICH build scripts that are now included in OpenCoarrays.
1 parent b3ba2e5 commit 9b43112

File tree

1 file changed

+33
-13
lines changed

1 file changed

+33
-13
lines changed

INSTALL.md

Lines changed: 33 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -26,28 +26,30 @@ source code.
2626
### OS X###
2727
</a>
2828

29-
We have developed a Portfile that we will submit for inclusion into the
30-
[MacPorts] package management software after posting the OpenCoarrays 1.0.0
31-
tar ball online. Once the OpenCoarrays Portfile has been incorporated into
32-
MacPorts, users can install OpenCoarrays on OS X by installing MacPorts and
33-
then typing the following:
29+
For now, OS X users will find it easiest to use OpenCoarrays inside the
30+
Lubuntu virtual machine available in the [Sourcery Institute Store].
31+
32+
In hopes of offering a straightforward, native OS X installation option, we
33+
have submitted a Portfile to the [MacPorts] package management software
34+
developers. Please add yourself to the "cc" list on the corresponding [ticket]
35+
for updates. Once Macports incorporates the OpenCoarrays Portfile, users will be
36+
to install OpenCoarrays by typing the following:
3437

3538
sudo port selfupdate
3639
sudo port upgrade outdated
3740
sudo port install opencoarrays
3841

39-
Administrator privileges are required for issuing the above "sudo" commands.
40-
Also, the first two steps above are required only if your MacPorts ports
41-
were last updated prior to the incorporation of the OpenCoarrays Portfile
42-
into MacPorts. The above process can be repeated to obtain updates in the
43-
form of future OpenCoarrays releases.
42+
where the "sudo" command requires Administrator privileges and where the first
43+
two steps above are required only if the MacPorts ports were last updated prior
44+
to the incorporation of the OpenCoarrays Portfile into MacPorts. Repeating the
45+
above steps will also install future OpenCoarrays updates.
4446

4547
<a name="windows">
4648
### Windows ###
4749
</a>
4850
Windows users will find it easiest to download the Lubuntu Linux virtual
49-
machine from the [Sourcery Store]. The virtual machine boots inside the
50-
open-source [VirtualBox] virtualization package. In addition to containing
51+
machine from the [Sourcery Institute Store]. The virtual machine boots inside
52+
the open-source [VirtualBox] virtualization package. In addition to containing
5153
GCC 4.9, 5.2, and 6.0, MPICH, OpenMPI, and OpenCoarrays, the virtual machine
5254
contains dozens of other open-source software packages that support software
5355
development in modern Fortran. See the [download and installation instructions]
@@ -58,7 +60,7 @@ for a partial list of the included packages.
5860
</a>
5961

6062
Linux users who prefer not to build OpenCoarrays from source might access
61-
OpenCoarrays via the the Lubuntu Linux virtual machine from the [Sourcery Store]
63+
OpenCoarrays via the the Lubuntu Linux virtual machine from the [Sourcery Institute Store]
6264
after installing the version of [VirtualBox] that is suitable for the relevant
6365
Linux distribution.
6466

@@ -82,6 +84,19 @@ install the following:
8284
Fortran and C compilers (preferably the [MPICH] or [MVAPICH] implementations for
8385
robustness and high performance)
8486

87+
The [install_prerequisites] directory contains experimental [buildgcc] and [buildmpich]
88+
bash shell scripts that can download and build any one of several versions of the [GCC]
89+
C, C++, and Fortran compilers, and [MPICH]. (Because newer parts of the GNU Fortran compiler
90+
(gfortran) are written in C++, installing the GNU Fortran compiler from source requires
91+
also installing the GNU C++ compiler (g++).) The CMAke scripts that build OpenCoarrays
92+
also copy [buildgcc] and [buildmpich] into the "bin" directory of the OpenCoarrays
93+
installation for later use.
94+
95+
We have the buildgcc and buildmpich scripts tested on OS X and Linux. Please submit
96+
suggestions for improving the scripts to our [Issues] page or preferably suggested edits by
97+
forking a copy of the [OpenCoarrays] repository, making the suggested edits, and submitting
98+
a pull request.
99+
85100
If installing the above prerequisites is infeasible, then a limited coverage of CAF
86101
features is available via the OpenCoarrays "caf" compiler wrapper and the
87102
[opencoarrays] module, for which the installation prerequisites are the following:
@@ -188,6 +203,7 @@ for an exhaustive description of the build process and options.
188203

189204
[End-User Installation]: #end-user-installation
190205
[OS X]: #os-x
206+
[ticket]: https://trac.macports.org/ticket/47806
191207
[Windows]: #windows
192208
[Linux]: #linux
193209
[Building from Source]: #building-from-source
@@ -196,13 +212,17 @@ for an exhaustive description of the build process and options.
196212
[Make]: #make
197213
[Obtaining GCC]: #obtaining-gcc
198214
[Sourcery Store]: http://www.sourceryinstitute.org/store
215+
[Sourcery Institute Store]: http://www.sourceryinstitute.org/store
199216
[Virtualbox]: http://www.virtualbox.org
200217
[download and installation instructions]: http://www.sourceryinstitute.org/uploads/4/9/9/6/49967347/overview.pdf
201218
[yum]: http://yum.baseurl.org
202219
[apt-get]: https://en.wikipedia.org/wiki/Advanced_Packaging_Tool
203220
[Issues]: https://github.com/sourceryinstitute/opencoarrays/issues
204221
[make.inc]: ./src/make.inc
205222
[opencoarrays]: ./src/extensions/opencoarrays.F90
223+
[install_prerequisites]: ./install_prerequisites
224+
[buildgcc]: ./install_prerequisites/buildgcc
225+
[buildmpich]: ./install_prerequisites/buildmpich
206226
[MPICH]: http://www.mpich.org
207227
[MVAPICH]:http://mvapich.cse.ohio-state.edu
208228
[Macports]: http://www.macports.org

0 commit comments

Comments
 (0)