/coarray_icar

Testing implementation of CoArrays for the basic ICAR algorithms

Primary LanguageFortranMIT LicenseMIT

Coarray ICAR

National Center for Atmospheric Research

This document provides information about the Coarray ICAR program.

CONTENTS

Installation and testing

Installation for Linux/OSX Operating Systems

Compile and test coarray in a bash shell on a Linux, macOS, or the Windows Subsystem for Linux:

  cd <path-to-coarray-icar>  # Change directory to the coarray_icar source directory
  mkdir build            # create the build directory
  cd build
  FC=<compiler-command> cmake .. -DCMAKE_INSTALL_PREFIX=<coarray-icar-install-path>
  make -j <number-of-processes>
  ctest

where

  • <path-to-coarray-icar> is the location of of the downloaded coarray ICAR source archive
  • <number-of-processes> is a count of the parallel processes that make should use, and
  • <compiler-command> is the command you use to invoke the compiler of your choice.
  • <coarray-icar-install-path> is the desired location for installing coarray ICAR

For example, you might specify, ~/coarray_icar, 4, and caf, respectively, if Coarray ICAR your home directoy, you want to accelerate the build by using 4 parallel processes, and you use the command caf to invoke the [OpenCoarrays] wrapper for the GNU Fortran compiler. Alternatively specify, ifort as the compiler command for to invoke the Intel Fortran compiler.

TODO: The CMake files need adjusting for building with non-GNU compilers.

Build options

Append -DNO_ASSERTIONS=ON to the above cmake command to turn off runtime checking of assertions.

System requirements

The following operating systems are supported:

  • Windows 10 Ubuntu Subsystem for Linux beta
  • Linux
  • macOS

The following compilers are supported:

  • Intel Fortran Compiler Version 16.0.0 or later OR
  • GNU Fortran Compiler Version 6.1.0 or later
  • GNU Makefile
  • CMake 3.7 or later (required for Fortran submodule support) OR
  • Cray Fortran Compiler (untested)

Generating documentation

Install the FORD Fortran documentation generator and type

  ford doc-generator.md

which will create doc/ subdirectory containing HTML files. Open doc/index.html for the Coarray ICAR documentation. On Linux, you might exeute the following at the command prompt:

  firefox doc/index.html &