OPAL-binary-package.asciidoc

+:TOC:
+:numbered:
+:blank: pass:[ +]
+
+'''
+
+== Overview 
+The newest stable version of OPAL is 2.4.0. 
+
+Versions with an odd minor version number like 2.1.2019.11 are development snapshots providing the newest features but less stability.
+
+'''
+
+## Installation of the OPAL binary distribution
+
+The package can be installed wherever you want. Let's name this directory `$PREFIX`.
+
+### On Linux
+
+1. change your working directory to `$PREFIX`
+1. download http://amas.web.psi.ch/Downloads/OPAL/package/OPAL-2.4.0-2-x86_64-linux.tar.xz[OPAL-2.4.0 for Linux]
+1. Un-tar the downloaded file:
++
+```
+tar xf OPAL-2.4.0-2-x86_64-linux.tar.xz
+```
+
+### On macOS
+1. change your working directory to `$PREFIX`
+1. download http://amas.web.psi.ch/Downloads/OPAL/package/OPAL-2.4.0-2-x86_64-macos.tar.xz[OPAL-2.4.0 for macOS]
+1. Un-tar the downloaded file:
++
+```
+tar xf OPAL-2.4.0-2-x86_64-macos.tar.xz
+```
+
+=== On Windows
+
+You have to use Windows Services for Linux and install the Linux package as documented above.
+
+== Running OPAL
+
+> **Note** MPI is included in the OPAL package. Be sure to use the MPI utilities shipped with the OPAL package!
+
+Source the OPAL shell profile. For the time being only sh-like shells - like BASH, ZSH - are supported.
+```
+source "$PREFIX/OPAL-2.4.0/etc/profile.d/opal.sh"
+```
+Now you are ready to run OPAL (assuming you have an input file `example.in`):
+```
+opal
+```
+or
+```
+opal example.in
+```
+or
+```
+mpirun -np 4 opal example.in
+```
+
+== ChangeLog
+
+> **Note** This is the ChangeLog for the binary package *not* _OPAL_!
+
+''''
+
+*OPAL 2.4.0-2 - 2020, September 1*
+
+- bugfix in the `opal.sh` shell profile
+- recompiled on Linux due to an illegal instruction in gfortran
+
+*OPAL 2.4.0-1 - 2020, August 28*
+
+- OPAL 2.4.0
+- AMR_MG and SAAMG solvers are enabled
+- update tool-chain
+
+*OPAL 2.2.1-1 - 2019, December 23*
+
+- bugfix release OPAL 2.2.1
+
+*OPAL 2.2.0-1 - 2019, December 23*
+
+- OPAL 2.2.0
+
+*OPAL 2.1.2019.11-1 - 2019, November 14*
+
+- OPAL 2.1.2019.11 (git rev. 33a9bd1999808243eb17be7093b3b9065e531c6f)
+- compiled without SAAMG solver
+- updated toolchain
+- H5root removed
+- root removed
+
+*OPAL 2.0.2-1 - 2019, November 14*
+
+- OPAL 2.0.2
+- compiled without SAAMG solver
+- updated toolchain
+- H5root removed
+- root removed
+
+*OPAL 2.0.1-1 - 2018, November 16*
+
+- update to OPAL 2.0.1
+- `parmetis` added
+- wrong paths in CMake scripts fixed
+
+''''
+
+*OPAL 2.0.0rc2-2 - 2018, June 28*
+
+- `binutils` added
+
+''''
+
+*OPAL 2.0.0rc2-1 - 2017, May 4*
+
+- first version with OPAL 2.0.0 release candidate 2
+
+''''
+
+*OPAL 1.6.1-3 - 2017, November 10th*
+
+- shared libraries like `libpng12`, `libz`, `libnuma` added to binary package.
+
+''''
+
+*OPAL 1.6.1-2 - 2017. November 6*
+
+- bug in H5root wrapper script fixed
+- file modes fixed
+- chowner/group set to `root:root`
+
+''''
+
+*OPAL 1.6.1-1 - 2017, October 27*
+
+- OPAL updated to version 1.6.1
+
+''''
+
+*OPAL 1.6.0-2 - 2017, September 29*
+
+- OPAL version 1.6.0
+- update tool-chain
+
+''''
+
+*OPAL 1.4.0-1 - 2017, June 6*
+
+- update to OPAL version 1.4.0
+
+''''
+
+*OPAL 1.3.2-3 - 2017, June 6*
+- add missing H5root (Linux package only!)
+
+''''
+
+*OPAL 1.3.2-2*
+
+- Fix in `vtk2h5grid`
+
+''''
+
+*OPAL 1.3.1-1*
+
+- update to OPAL version 1.3.1
+
+''''
+
+== Old OPAL versions
+
+:lnk_pkg: http://amas.web.psi.ch/Downloads/OPAL/package/
+:linux_pkg: -x86_64-linux.tar.xz[tar.xz]
+:linux_md5: -x86_64-linux.tar.xz.md5[md5]
+:macos_pkg: -x86_64-macos.tar.xz[tar.xz]
+:macos_md5: -x86_64-macos.tar.xz.md5[md]
+
+[%header,width="80%",cols="2,2,2,2,2"]
+|========
+| Version 
+| Source
+| Linux
+| macOS
+| Release Notes
+
+| OPAL-2.1.2019.11-1
+|
+| {lnk_pkg}/OPAL-2.1.2019.11-1{linux_pkg}, {lnk_pkg}OPAL-2.1.2019.11-1{linux_md5} 
+| {lnk_pkg}/OPAL-2.1.2019.11-1{macos_pkg}, {lnk_pkg}OPAL-2.1.2019.11-1{macos_md5}
+| link:ReleaseNotes/OPAL%202.0[release notes]
+
+| OPAL-2.0.1-1
+|
+| {lnk_pkg}/OPAL-2.0.1-1{linux_pkg}, {lnk_pkg}OPAL-2.0.1-1{linux_md5} 
+| 
+| link:ReleaseNotes/OPAL%202.0[release notes]
+
+| OPAL-2.0.0rc2-2
+|
+| {lnk_pkg}/OPAL-2.0.0rc2-2{linux_pkg}, {lnk_pkg}OPAL-2.0.0rc2-2{linux_md5} 
+| 
+| link:ReleaseNotes/OPAL%202.0[release notes]
+
+| OPAL-2.0.0rc2-1
+|
+| {lnk_pkg}/OPAL-2.0.0rc2-1{linux_pkg}, {lnk_pkg}OPAL-2.0.0rc2-1{linux_md5} 
+| 
+| link:ReleaseNotes/OPAL%202.0[release notes]
+
+| OPAL-1.6.2-1
+|
+| {lnk_pkg}/OPAL-1.6.2-1{linux_pkg}, {lnk_pkg}OPAL-1.6.2-1{linux_md5} 
+| 
+| link:ReleaseNotes/OPAL%201.6[release notes]
+
+| OPAL-1.6.1-3
+|
+| {lnk_pkg}/OPAL-1.6.1-3{linux_pkg}, {lnk_pkg}OPAL-1.6.1-3{linux_md5} 
+| 
+| link:ReleaseNotes/OPAL%201.6[release notes]
+
+| OPAL-1.6.0-2
+|
+| {lnk_pkg}/OPAL-1.6.0-2{linux_pkg}, {lnk_pkg}OPAL-1.6.0-2{linux_md5} 
+| 
+| link:ReleaseNotes/OPAL%201.6[release notes]
+
+| 
+|
+| {lnk_pkg}/{linux_pkg}, {lnk_pkg}{linux_md5} 
+| 
+| link:ReleaseNotes/OPAL%202.0[release notes]
+
+|========
+
+
+[width="80%",cols="3,2,2"]
+|========
+
+| http://amas.web.psi.ch/Downloads/OPAL/package/OPAL-1.4.0-1-x86_64-linux.tar.bz2[OPAL-1.4.0-1 for Linux]
+| http://amas.web.psi.ch/Downloads/OPAL/package/OPAL-1.4.0-1-x86_64-linux.tar.bz2.md5[md5 sum] 
+| link:ReleaseNotes/OPAL%201.4.0[release notes] 
+
+| http://amas.web.psi.ch/Downloads/OPAL/package/OPAL-1.4.0-1-x86_64-apple-darwin.tar.bz2.md5[OPAL-1.4.0-1 for macOS]
+| http://amas.web.psi.ch/Downloads/OPAL/package/OPAL-1.4.0-1-x86_64-apple-darwin.tar.bz2[md5 sum]
+| link:ReleaseNotes/OPAL%201.4.0[release notes] 
+
+| http://amas.web.psi.ch/Downloads/OPAL/package/OPAL-1.3.2-3-x86_64-linux.tar.bz2[OPAL-1.3.2-3 for Linux]
+| http://amas.web.psi.ch/Downloads/OPAL/package/OPAL-1.3.2-3-x86_64-linux.tar.bz2.md5[md5 sum] 
+| link:ReleaseNotes/OPAL%201.4.0[release notes] 
+
+| http://amas.web.psi.ch/Downloads/OPAL/package/OPAL-1.3.2-2-x86_64-linux.tar.bz2[OPAL-1.3.2-2 for Linux]
+| http://amas.web.psi.ch/Downloads/OPAL/package/OPAL-1.3.2-2-x86_64-linux.tar.bz2.md5[md5 sum]
+| link:ReleaseNotes/OPAL%201.4.0[release notes] 
+
+| http://amas.web.psi.ch/Downloads/OPAL/package/OPAL-1.3.2-2-x86_64-apple-darwin.tar.bz2.md5[OPAL-1.3.2-3 for macOS]
+| http://amas.web.psi.ch/Downloads/OPAL/package/OPAL-1.3.2-2-x86_64-apple-darwin.tar.bz2[md5 sum]
+| link:ReleaseNotes/OPAL%201.4.0[release notes] 
+
+| http://amas.web.psi.ch/Downloads/OPAL/package/OPAL-1.3.1-1-x86_64-linux.tar.bz2[OPAL-1.3.1-1 for Linux]
+| http://amas.web.psi.ch/Downloads/OPAL/package/OPAL-1.3.1-1-x86_64-linux.tar.bz2.md5[md5 sum] 
+| link:ReleaseNotes/OPAL%201.4.0[release notes] 
+
+| http://amas.web.psi.ch/Downloads/OPAL/package/OPAL-1.3.1-1-x86_64-apple-darwin.tar.bz2.md5[OPAL-1.3.1-1 for macOS]
+| http://amas.web.psi.ch/Downloads/OPAL/package/OPAL-1.3.1-1-x86_64-apple-darwin.tar.bz2[md5 sum]
+| link:ReleaseNotes/OPAL%201.4.0[release notes] 
+
+|========
\ No newline at end of file