Merge branch 'master' into bugfix-event_wait

Author: zbeekman

CMakeLists.txt

@@ -81,7 +81,7 @@ if ("${CMAKE_CURRENT_SOURCE_DIR}" STREQUAL "${CMAKE_CURRENT_BINARY_DIR}")
     "in a manner such as\n"
     "  $ mkdir build-opencarrays\n"
     "  $ cd build-opencoarrays\n"
-    "  $ CC=mpicc FC=mpif90 cmake <path-to-opencoarrays-source-directory> -DCMAKE_INSTALL_PREFIX=<path-to-install-directory>\n"
+    "  $ CC=gcc FC=gfortran cmake -DBUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/path/to/install/dir /path/to/opencoarrays/src/dir \n"
     "\nsubstituting the appropriate syntax for your shell (the above line assumes the bash shell)."
     )
 endif()
@@ -188,7 +188,7 @@ endif()
 # Find MPI and set some flags so that FC and CC can point to gfortran and gcc
 #----------------------------------------------------------------------------
 
-# If the user passes FC=mpif90 etc. check and prefer that location
+# If the user passes FC=mpifort etc. check and prefer that location
 get_filename_component( FTN_COMPILER_NAME "${CMAKE_Fortran_COMPILER}"
   NAME )
 get_filename_component( C_COMPILER_NAME "${CMAKE_C_COMPILER}"

GETTING_STARTED.md

@@ -107,13 +107,13 @@ If the `caf` compiler wrapper cannot process the source code in question, invoke
 the underlying communication library directly:
 
 ```bash
-mpif90 -fcoarray=lib -L/opt/opencoarrays/ tally.f90 \ -lcaf_mpi -o htally -I<OpenCoarrays-install-path>/mod
+mpifort -fcoarray=lib -L/opt/opencoarrays/ tally.f90 \ -lcaf_mpi -o htally -I<OpenCoarrays-install-path>/mod
 ```
 
 and also run the program with the lower-level communication library:
 
 ```bash
-mpirun -np <number-of-images> ./tally
+mpiexec -np <number-of-images> ./tally
 ```
 
 ---

INSTALL.md

@@ -119,25 +119,71 @@ thread starting with [commit comment 20539810].
 
 ### Linux ###
 
-Acces OpenCoarrays on Linux via any of the following package managers
+Access OpenCoarrays on Linux via any of the following package managers
 or pre-installed copies:
 
 * The [linuxbrew] package manager installs OpenCoarrays on all Linux distributions.
 * Debian-based distributions such as Ubuntu provide an "open-coarrays" [APT package].
 * [Arch Linux] provides an [aur package].
 * [HPCLinux] includes a pre-installed copy of OpenCoarrays.
+* [EasyBuild], a software build and installation framework, can install
+  OpenCoarrays on Linux distributions
+* [Spack], a multiplatform package manager, can also install OpenCoarrays on Linux distributions
+
 
 [linuxbrew] does not require `sudo` privileges and will generally
 provide the most up-to-date OpenCoarrays release because linxubrew
 pulls directly from macOS homebrew, which updates automatically.
 
+
+<a name="easybuild"></a>
+[EasyBuild] can be used to install OpenCoarrays with the following bash commands:
+```bash
+# Search available specification files (also known as easyconfigs) for OpenCoarrays
+eb --search OpenCoarrays
+
+# Automatically download prerequisites (with the --robot flag) and install OpenCoarrays
+# with the desired easyconfig, e.g., OpenCoarrays-1.9.0-gompi-2017a.eb
+eb OpenCoarrays-1.9.0-gompi-2017a.eb --robot
+```
+Once installed, OpenCoarrays can be used by loading the newly created environment
+module `OpenCoarrays/1.9.0-gompi-2017a`.
+```bash
+module load OpenCoarrays/1.9.0-gompi-2017a
+```
+
+
+<a name="spack"></a>
+[Spack] can be used to install OpenCoarrays with the following bash commands:
+```bash
+# Check build information for OpenCoarrays in the default specification file
+spack spec opencoarrays
+
+# To automatically download prerequisites and install OpenCoarrays with the default specification.
+# (Note: In addition to its own prerequisites, Spack requires gfortran compiler
+# to be installed to compile OpenMPI)
+spack install opencoarrays
+
+# Or, To install with customisations (e.g., to install OpenCoarrays [version 1.9.0]
+# with MPICH [version default] and GCC [version 7.1.0]).
+spack install [email protected] ^mpich %[email protected]
+```
+In the previous example, it was assumed that GCC [version 7.1.0] is already installed, and is available as
+a compiler to Spack. Otherwise, [add a new compiler to Spack].
+Once installed, OpenCoarrays can be used by [loading the environment modules with Spack], e.g.
+```bash
+spack module loads --dependencies opencoarrays
+```
+
 [top]
 
 ### FreeBSD ###
 
-A FreeBSD Port is available for installing OpenCoarrays and can be
-located via [port search].  See the FreeBSD OpenCoarrays [port details]
-page for installation instructions.
+A FreeBSD Port is available for installing OpenCoarrays.  FreeBSD users can now simply do the following as root:
+```bash
+pkg install opencoarrays
+```
+For more information, please review the [FreeBSD ports/packages installation information](https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ports.html).
 
 [top]
 
@@ -422,3 +468,7 @@ export gcc_install_path=/desired/installation/destination
 [dnf]: https://github.com/rpm-software-management/dnf
 [port details]: http://www.freshports.org/lang/opencoarrays
 [port search]: https://www.freebsd.org/cgi/ports.cgi?query=opencoarrays
+[EasyBuild]: https://github.com/easybuilders/easybuild
+[Spack]: https://github.com/LLNL/spack
+[add a new compiler to Spack]: http://spack.readthedocs.io/en/latest/tutorial_modules.html#add-a-new-compiler
+[loading the environment modules with Spack]: http://spack.readthedocs.io/en/latest/module_file_support.html#cmd-spack-module-loads

README.md

@@ -46,14 +46,14 @@ OpenCoarrays provides a compiler wrapper (named `caf`), a runtime
 library (named `libcaf_mpi.a` by default), and an executable file
 launcher (named `cafrun`).  With OpenCoarrays-aware compilers, the
 compiler wrapper passes the provided source code to the chosen
-compiler (`mpif90` by default).  For non-OpenCoarrays-aware compilers,
+compiler (`mpifort` by default).  For non-OpenCoarrays-aware compilers,
 the wrapper transforms CAF syntax into OpenCoarrays procedure calls
 before invoking the chosen compiler on the transformed code.  The
 runtime library supports compiler communication and synchronization
 requests by invoking a lower-level communication library--the Message
 Passing Interface ([MPI]) by default.  The launcher passes execution
 to the chosen communication library's parallel program launcher
-(`mpirun` by default).
+(`mpiexec` by default).
 
 OpenCoarrays defines an application binary interface ([ABI]) that
 translates high-level communication and synchronization requests into

developer-scripts/hpclinux-install.sh

@@ -2,37 +2,37 @@
 
 # BSD 3-Clause License
 #
-# -- hpclinux-install.sh 
-#   
+# -- hpclinux-install.sh
+#
 #  Install OpenCoarrays inside the HPCLinux distribution from hpclinux.org.
 #
 #  Usage: cd opencoarrays && ./prerequisites/hpclinux-install.sh"
 #
 #  Motivation:
 #
-#    On Fedora-based distributions, the OpenCoarrays installer fails during the stack-based 
-#    system interrogation (presumably due to problems with the prerequisites/stack.sh script).  
-#    At least in the case of HPCLinux, system interrogation is unnecessary because HPCLinux is 
-#    uber-stable and it's  safe bet that all prerequisites need to be installed so this script 
+#    On Fedora-based distributions, the OpenCoarrays installer fails during the stack-based
+#    system interrogation (presumably due to problems with the prerequisites/stack.sh script).
+#    At least in the case of HPCLinux, system interrogation is unnecessary because HPCLinux is
+#    uber-stable and it's  safe bet that all prerequisites need to be installed so this script
 #    omits the interrogation and invokes prerequisites/build.sh to build all prerequisites.
-# 
+#
 # Copyright (c) 2016, Sourcery Institute
 # All rights reserved.
-# 
+#
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
-# 
+#
 # * Redistributions of source code must retain the above copyright notice, this
 #   list of conditions and the following disclaimer.
-# 
+#
 # * Redistributions in binary form must reproduce the above copyright notice,
 #   this list of conditions and the following disclaimer in the documentation
 #   and/or other materials provided with the distribution.
-# 
+#
 # * Neither the name of the copyright holder nor the names of its
 #   contributors may be used to endorse or promote products derived from
 #   this software without specific prior written permission.
-# 
+#
 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@@ -45,57 +45,58 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 if [[ ! -d prerequisites ]]; then
-   echo "Please execute this script with your present working directory"
-   echo "set to the top level of the OpenCoarrays source tree."
-   exit 1
+  printf "Please execute this script with your present working directory"
+  printf "set to the top level of the OpenCoarrays source tree."
+  exit 1
 fi
 
 pushd prerequisites
 
-  # Build CMake using the system GCC (4.8.1) and prepend its bin subdirectory to the PATH
-  export cmake_install_path="${PWD}"/installations/cmake/cmake
-  ./build.sh --package cmake --install-prefix "${cmake_install_path}"
-  if [[ -z "${PATH}" ]]; then
-    export PATH="${cmake_install_path}"/bin
-  else
-    export PATH="${cmake_install_path}"/bin:$PATH
-  fi
+# Build CMake using the system GCC (4.8.1) and prepend its bin subdirectory to the PATH
+export cmake_install_path="${PWD}/installations/cmake/cmake"
+./build.sh --package cmake --install-prefix "${cmake_install_path}"
+if [[ -z "${PATH}" ]]; then
+  export PATH="${cmake_install_path}/bin"
+else
+  export PATH="${cmake_install_path}/bin:${PATH}"
+fi
 
-  # Build GCC 6.3.0 and prepend its bin subdirectory to the PATH
-  export gcc_version=6.3.0
-  export gcc_install_path="${PWD}"/installations/gnu/$gcc_version
-  ./build.sh --package gcc --install-version $gcc_version --install-prefix "${gcc_install_path}"
-  export PATH="${gcc_install_path}"/bin:$PATH
-  export LD_LIBRARY_PATH="${gcc_install_path}"/lib64:"${gcc_install_path}"/lib:$LD_LIBRARY_PATH
+# Build GCC 6.3.0 and prepend its bin subdirectory to the PATH
+export gcc_version=6.3.0
+export gcc_install_path="${PWD}/installations/gnu/${gcc_version}"
+./build.sh --package gcc --install-version "${gcc_version}" --install-prefix "${gcc_install_path}"
+export PATH="${gcc_install_path}/bin:${PATH}"
+export LD_LIBRARY_PATH="${gcc_install_path}/lib64:${gcc_install_path}/lib:${LD_LIBRARY_PATH}"
 
-  # Build MPICH 3.2 and prepend its bin subdirectory to the PATH
-  export mpich_install_path="${PWD}"/installations/mpich
-  ./build.sh --package mpich --install-prefix "${mpich_install_path}" --num-threads 4
-  export PATH="${mpich_install_path}"/bin:$PATH
+# Build MPICH 3.2 and prepend its bin subdirectory to the PATH
+export mpich_install_path="${PWD}/installations/mpich"
+./build.sh --package mpich --install-prefix "${mpich_install_path}" --num-threads 4
+export PATH="${mpich_install_path}/bin:${PATH}"
 
 popd # return to top level of OpenCoarrays source tree
 
 # Build OpenCoarrays
 if [[ -d build ]]; then
-  echo -e 'Old build subdirectory found. Ok to delete the "build" subdirectory? (Y/n) '
+  printf 'Old build subdirectory found. Ok to delete the "build" subdirectory? (Y/n)'
   read -r delete_build
 
-  if [[ "$delete_build" == "n" || "$delete_build" == "no" ]]; then
+  if [[ "${delete_build}" == "n" || "${delete_build}" == "no" ]]; then
     printf "n\n"
-    echo -e "Please rename or delete the build subdirectory and restart this script. Aborting. [exit 10]\n"
+    printf "Please rename or delete the build subdirectory and restart this script. Aborting. [exit 10]\n"
     exit 10
   else # permission granted to delete build subdirectory
     printf "Y\n"
-  fi  
+  fi
   rm -rf build
 fi
 mkdir build
 pushd build
 
-  export opencoarrays_install_path="${PWD}"/prerequisites/installations/opencoarrays
-  FC=gfortran CC=gcc cmake .. -DCMAKE_INSTALL_PREFIX="{opencoarrays_install_path}"
-  make
-  make install
-  export PATH="${opencoarrays_install_path}"/bin:$PATH
+export opencoarrays_install_path="${PWD}/prerequisites/installations/opencoarrays"
+FC=gfortran CC=gcc cmake .. -DCMAKE_INSTALL_PREFIX="${opencoarrays_install_path}"
+make
+ctest --output-on-failure --schedule-random
+make install
+export PATH="${opencoarrays_install_path}/bin:${PATH}"
 
 popd # return to top level of OpenCoarrays source tree

developer-scripts/patched-trunk-install.sh

@@ -179,7 +179,7 @@ echo "Building MPICH with the patched compilers."
 
 # Verify that MPICH installed where expected
 mpich_install_path=$(./install.sh -P mpich)
-if ! type "${mpich_install_path}"/bin/mpif90; then
+if ! type "${mpich_install_path}"/bin/mpifort; then
   echo "MPICH is not installed in the expected location ${mpich_install_path}."
   exit 1
 fi

install.sh

@@ -234,6 +234,9 @@ source $opencoarrays_src_dir/prerequisites/install-functions/build_opencoarrays.
 # shellcheck source=./prerequisites/install-functions/report_results.sh
 source $opencoarrays_src_dir/prerequisites/install-functions/report_results.sh
 
+# shellcheck source=./prerequisites/install-functions/install-xcode-clt.sh
+source "${opencoarrays_src_dir}/prerequisites/install-functions/install-xcode-clt.sh"
+
 # ___________________ End of function definitions for use in the Main Body __________________
 
 
@@ -303,6 +306,8 @@ elif [[ "${arg_p:-}" == "opencoarrays" ]]; then
 
   else
 
+    # Install Xcode command line tools (CLT) if on macOS and if needed
+    maybe_install_xcodeCLT
     # Install OpenCoarrays
     cd prerequisites || exit 1
     installation_record=install-opencoarrays.log
@@ -320,12 +325,18 @@ elif [[ "${arg_p:-}" == "opencoarrays" ]]; then
 
 elif [[ "${arg_p:-}" == "ofp" ]]; then
 
+  # Install Xcode command line tools (CLT) if on macOS and if needed
+  maybe_install_xcodeCLT
+
   info "Invoking Open Fortran Parser build script with the following command:"
   info "\"${opencoarrays_src_dir}\"/prerequisites/install-ofp.sh"
   "${opencoarrays_src_dir}"/prerequisites/install-ofp.sh
 
 elif [[ ! -z "${arg_p:-}" ]]; then
 
+  # Install Xcode command line tools (CLT) if on macOS and if needed
+  maybe_install_xcodeCLT
+
   info "Invoking build script with the following command:"
   info "\"${opencoarrays_src_dir}\"/prerequisites/build.sh ${*:-}"
   "${opencoarrays_src_dir}"/prerequisites/build.sh "${@:-}"

prerequisites/install-functions/find_or_install.sh

@@ -8,7 +8,7 @@ find_or_install()
   package_executable_array=(
     "gcc:gfortran"
     "cmake:cmake"
-    "mpich:mpif90"
+    "mpich:mpifort"
     "flex:flex"
     "bison:yacc"
     "m4:m4"
@@ -121,11 +121,11 @@ find_or_install()
     # MPIFC, MPICC, and MPICXX environment variables. Every branch must also manage the
     # dependency stack.
 
-    # If the user specified a Fortran compiler, verify that mpif90 wraps the specified compiler
+    # If the user specified a Fortran compiler, verify that mpifort wraps the specified compiler
     if [[ ! -z "${arg_M:-}" ]]; then
 
       echo -e "$this_script: Using the $package specified by -M or --with-mpi: ${arg_M}\n"
-      export MPIFC="${arg_M}"/bin/mpif90
+      export MPIFC="${arg_M}"/bin/mpifort
       export MPICC="${arg_M}"/bin/mpicc
       export MPICXX="${arg_M}"/bin/mpicxx
       # Halt the recursion
@@ -136,7 +136,7 @@ find_or_install()
     elif [[ "$script_installed_package" == true ]]; then
 
       echo -e "$this_script: Using the $package installed by $this_script\n"
-      export MPIFC=$package_install_path/bin/mpif90
+      export MPIFC=$package_install_path/bin/mpifort
       export MPICC=$package_install_path/bin/mpicc
       export MPICXX=$package_install_path/bin/mpicxx
       # Halt the recursion
@@ -147,8 +147,8 @@ find_or_install()
     elif [[ "$package_in_path" == "true" ]]; then
 
       echo -e "$this_script: Checking whether $executable in PATH wraps gfortran... "
-      mpif90_version_header=$(mpif90 --version | head -1)
-      first_three_characters=$(echo "$mpif90_version_header" | cut -c1-3)
+      mpifort_version_header=$(mpifort --version | head -1)
+      first_three_characters=$(echo "$mpifort_version_header" | cut -c1-3)
       if [[ "$first_three_characters" != "GNU" ]]; then
         printf "no.\n"
         # Trigger 'find_or_install gcc' and subsequent build of $package
@@ -162,7 +162,7 @@ find_or_install()
 
           info "-f (or --with-fortran) argument detected with value ${arg_f}"
           printf "yes.\n %s: Using the specified %s.\n" "$this_script" "$executable"
-          export MPIFC=mpif90
+          export MPIFC=mpifort
           export MPICC=mpicc
           export MPICXX=mpicxx
 
@@ -185,7 +185,7 @@ find_or_install()
           fi
           if [[ "$acceptable" == "${is_true:-}" ]]; then
             printf "yes.\n %s: Using the $executable found in the PATH.\n" "$this_script"
-            export MPIFC=mpif90
+            export MPIFC=mpifort
             export MPICC=mpicc
             export MPICXX=mpicxx
 
@@ -637,8 +637,8 @@ find_or_install()
             export LD_LIBRARY_PATH="$gfortran_lib_paths:$LD_LIBRARY_PATH"
           fi
         elif [[ $package == "mpich" ]]; then
-          echo "$this_script: export MPIFC=$package_install_path/bin/mpif90"
-                              export MPIFC="$package_install_path/bin/mpif90"
+          echo "$this_script: export MPIFC=$package_install_path/bin/mpifort"
+                              export MPIFC="$package_install_path/bin/mpifort"
           echo "$this_script: export MPICC= $package_install_path/bin/mpicc"
                               export MPICC="$package_install_path/bin/mpicc"
           echo "$this_script: export MPICXX=$package_install_path/bin/mpicxx"