Skip to content

Commit a8b95c9

Browse files
committed
Copying README.md from release branch.
1 parent 69af08c commit a8b95c9

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
# OpenCoarrays #
66

77
* [Overview]
8+
* [Downloads]
89
* [Compatibility]
910
* [Prerequisites]
1011
* [Installation]
@@ -18,11 +19,17 @@ OpenCoarrays provides a compiler wrapper (named "caf"), a runtime library (named
1819

1920
OpenCoarrays defines an application binary interface ([ABI]) that translates high-level communication and synchronization requests into low-level calls to a user-specified communication library. This design decision liberates compiler teams from hardwiring communication-library choice into their compilers and it frees Fortran programmers to express parallel algorithms once and reuse identical CAF source with whichever communication library is most efficient for a given hardware platform. The communication substrate for OpenCoarrays built with the preferred build system, CMake, is the Message Passing Interface ([MPI]).
2021

22+
OpenCoarrays enables CAF application developers to express parallel algorithms without hardwiring a particular version of a particular communication library or library version into their codes. Such abstraction makes application code less sensitive to the evolution of the underlying communication libraries and hardware platforms.
23+
24+
<a name="downloads">
25+
## Downloads</a> ##
26+
Please see our [Releases] page.
27+
2128
## <a name="compatibility">Compatibility</a> ##
2229
The GNU Compiler Collection ([GCC]) Fortran front end ([gfortran]) is OpenCoarrays-aware for release versions 5.1.0 and higher. Users of other compilers, including earlier versions of gfortran, can access a limited subset of CAF features via the provided [opencoarrays module]. After installation, please execute the "caf" script (which is installed in the "bin" directory of the installation path) with no arguments to see a list of the corresponding limitations. Please also notify the corresponding compiler vendor and the OpenCoarrays team that you would like for a future version of the compiler to be OpenCoarrays-aware.
2330

2431
## <a name="prerequisites">Prerequisites</a> ##
25-
We expect our LIBCAF_MPI library to be the default OpenCoarrays library. LIBCAF_MPI is the most straightforward to install and use, the most robust in terms of its internal complexity, and the most frequently updated and maintained. Building LIBCAF_MPI requires prior installation of an MPI implementation. We recommend [MPICH] generally or, if available, [MVAPICH] for better performance. [OpenMPI] is another option.
32+
We expect our LIBCAF_MPI library to be the default OpenCoarrays library. LIBCAF_MPI is the most straightforward to install and use, the most robust in terms of its internal complexity, and the most frequently updated and maintained. Building LIBCAF_MPI requires prior installation of an MPI implementation. We recommend [MPICH] generally or, if available, [MVAPICH] for better performance. [OpenMPI] is another option.
2633

2734
We offer an unsupported LIBCAF_GASNet alternative. We intend for LIBCAF_GASNet to be an "expert" alternative capable of outperforming MPI for some applications on some platforms. LIBCAF_GASNet requires greater care to configure and use and building LIBCAF_GASNet requires prior installation of [GASNet].
2835

@@ -55,7 +62,7 @@ Please see the [STATUS.md] file.
5562
## <a name="acknowledgements">Acknowledgements</a> ##
5663
We gratefully acknowledge support from the following institutions:
5764

58-
* The National Center for Atmospheric Research [NCAR] for access to the Yellowstone/Caldera supercomputers and for logistics support during the initial development of OpenCoarrays.
65+
* [National Center for Atmospheric Research] for access to the Yellowstone/Caldera supercomputers and for logistics support during the initial development of OpenCoarrays.
5966
* [CINECA] for access to Eurora/PLX for the project HyPS- BLAS under the ISCRA grant program for 2014.
6067
* [Google] for support of a related [Google Summer of Code] 2014 project.
6168
* The National Energy Research Scientific Computing Center ([NERSC]), which is supported by the Office of Science of the U.S. Department of Energy under Contract No. DE-AC02-05CH11231, for access to the Hopper and Edison supercomputers under the OpenCoarrays project start allocation.
@@ -64,13 +71,14 @@ We gratefully acknowledge support from the following institutions:
6471
[Hyperlinks]:#
6572

6673
[Overview]: #overview
74+
[Downloads]: #downloads
6775
[Compatibility]: #compatibility
6876
[Prerequisites]: #prerequisites
6977
[Installation]: #installation
7078
[Contributing]: #contributing
7179
[Acknowledgements]: #acknowledgements
7280

73-
[NCAR]: https://ncar.ucar.edu
81+
7482
[OpenCoarrays]: http://www.opencoarrays.org
7583
[ABI]: https://gcc.gnu.org/onlinedocs/gfortran/Function-ABI-Documentation.html#Function-ABI-Documentation
7684
[TS 18508]: http://isotc.iso.org/livelink/livelink?func=ll&objId=16769292&objAction=Open
@@ -99,3 +107,4 @@ We gratefully acknowledge support from the following institutions:
99107
[Google Summer of Code]: https://www.google-melange.com
100108
[OpenCoarrays Google Group]: https://groups.google.com/forum/#!forum/opencoarrays)
101109
[Issues]: https://github.com/sourceryinstitute/opencoarrays/issue
110+
[Releases]: https://github.com/sourceryinstitute/opencoarrays/releases

0 commit comments

Comments
 (0)