Skip to content

Commit b738bab

Browse files
authored
Merge pull request #414 from anujsharmax/issue-387
RFE: Add EasyBuild option in INSTALL.md
2 parents 8977be3 + c0bbc16 commit b738bab

File tree

1 file changed

+49
-1
lines changed

1 file changed

+49
-1
lines changed

INSTALL.md

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,18 +119,62 @@ thread starting with [commit comment 20539810].
119119

120120
### Linux ###
121121

122-
Acces OpenCoarrays on Linux via any of the following package managers
122+
Access OpenCoarrays on Linux via any of the following package managers
123123
or pre-installed copies:
124124

125125
* The [linuxbrew] package manager installs OpenCoarrays on all Linux distributions.
126126
* Debian-based distributions such as Ubuntu provide an "open-coarrays" [APT package].
127127
* [Arch Linux] provides an [aur package].
128128
* [HPCLinux] includes a pre-installed copy of OpenCoarrays.
129+
* [EasyBuild], a software build and installation framework, can install
130+
OpenCoarrays on Linux distributions
131+
* [Spack], a multiplatform package manager, can also install OpenCoarrays on Linux distributions
132+
129133

130134
[linuxbrew] does not require `sudo` privileges and will generally
131135
provide the most up-to-date OpenCoarrays release because linxubrew
132136
pulls directly from macOS homebrew, which updates automatically.
133137

138+
139+
<a name="easybuild"></a>
140+
[EasyBuild] can be used to install OpenCoarrays with the following bash commands:
141+
```bash
142+
# Search available specification files (also known as easyconfigs) for OpenCoarrays
143+
eb --search OpenCoarrays
144+
145+
# Automatically download prerequisites (with the --robot flag) and install OpenCoarrays
146+
# with the desired easyconfig, e.g., OpenCoarrays-1.9.0-gompi-2017a.eb
147+
eb OpenCoarrays-1.9.0-gompi-2017a.eb --robot
148+
```
149+
Once installed, OpenCoarrays can be used by loading the newly created environment
150+
module `OpenCoarrays/1.9.0-gompi-2017a`.
151+
```bash
152+
module load OpenCoarrays/1.9.0-gompi-2017a
153+
```
154+
155+
156+
<a name="spack"></a>
157+
[Spack] can be used to install OpenCoarrays with the following bash commands:
158+
```bash
159+
# Check build information for OpenCoarrays in the default specification file
160+
spack spec opencoarrays
161+
162+
# To automatically download prerequisites and install OpenCoarrays with the default specification.
163+
# (Note: In addition to its own prerequisites, Spack requires gfortran compiler
164+
# to be installed to compile OpenMPI)
165+
spack install opencoarrays
166+
167+
# Or, To install with customisations (e.g., to install OpenCoarrays [version 1.9.0]
168+
# with MPICH [version default] and GCC [version 7.1.0]).
169+
170+
```
171+
In the previous example, it was assumed that GCC [version 7.1.0] is already installed, and is available as
172+
a compiler to Spack. Otherwise, [add a new compiler to Spack].
173+
Once installed, OpenCoarrays can be used by [loading the environment modules with Spack], e.g.
174+
```bash
175+
spack module loads --dependencies opencoarrays
176+
```
177+
134178
[top]
135179

136180
### FreeBSD ###
@@ -422,3 +466,7 @@ export gcc_install_path=/desired/installation/destination
422466
[dnf]: https://github.com/rpm-software-management/dnf
423467
[port details]: http://www.freshports.org/lang/opencoarrays
424468
[port search]: https://www.freebsd.org/cgi/ports.cgi?query=opencoarrays
469+
[EasyBuild]: https://github.com/easybuilders/easybuild
470+
[Spack]: https://github.com/LLNL/spack
471+
[add a new compiler to Spack]: http://spack.readthedocs.io/en/latest/tutorial_modules.html#add-a-new-compiler
472+
[loading the environment modules with Spack]: http://spack.readthedocs.io/en/latest/module_file_support.html#cmd-spack-module-loads

0 commit comments

Comments
 (0)