diff --git a/pages/installation.md b/pages/installation.md index 5daebb0..07ae543 100644 --- a/pages/installation.md +++ b/pages/installation.md @@ -7,7 +7,16 @@ teaser: "" permalink: /installation/ --- -1. Before you proceed, please make sure you have a working version of [OpenFOAM v4.1](http://www.openfoam.org/archive/4.1/download/source.php) or [OpenFOAM v1606+](http://openfoam.com/download/install-binary.php) installed in your system. HELYX-OS v2.4.0 is designed to work only with this particular version of OpenFOAM. If you are using Ubuntu 14.04 or greater, the installer provided can download and install the proper version of OpenFOAM, as explained below during steps 8 to 10. +HELYX-OS v2.4.0 is designed to work only with [OpenFOAM v4.1](http://www.openfoam.org/archive/4.1/download/source.php) or [OpenFOAM v1606+](http://openfoam.com/download/install-binary.php). The HELYX-OS installation instructions will vary slightly, depending on which version of OpenFOAM you have installed. Additionally, users are free to download the HELYX-OS source and compile separately. See the following sub sections for more information: + +- [HELYX-OS Installation for OpenFOAM v4.1](#v41) +- [HELYX-OS Installation for OpenFOAM vv1606+](#v1606) +- [HELYX-OS Installation from source](#fromSource) + +Please report all bugs encountered with HELYX-OS on the [project issue tracker](https://github.com/ENGYS/HELYX-OS/issues). + +## HELYX-OS Installation for OpenFOAM v4.1 +1. Before you proceed, please make sure you have a working version of [OpenFOAM v4.1](http://www.openfoam.org/archive/4.1/download/source.php). If you are using Ubuntu 14.04 or greater, the installer provided can download and install the OpenFOAM v4.1, as explained below during steps 8 to 10. 2. Download the [latest 64 Bit binary of HELYX-OS](https://github.com/ENGYS/HELYX-OS/releases/download/v2.4.0/HELYX-OS-2.4.0-linux-x86_64.bin) from the [project releases](https://github.com/ENGYS/HELYX-OS/releases) or the [project front page](http://engys.github.io/HELYX-OS/). The installer name will have the form: @@ -78,7 +87,19 @@ permalink: /installation/ :~$ ~/Engys/HELYX-OS/v2.4.0/HELYX-OS.sh +12. Finally, start a new case and open Edit>Preferences in the menu. Ensure that you have selected the location of the OpenFOAM V4.1 installation and you are ready to start using HELYX-OS + Please report all bugs encountered with HELYX-OS on the [project issue tracker](https://github.com/ENGYS/HELYX-OS/issues). -## Compilation from Source -For the latest instructions on how to compile HELYX-OS from source, please see the git repository [README](https://github.com/ENGYS/HELYX-OS/blob/master/README.md) file inside the [HELYX-OS repository](https://github.com/ENGYS/HELYX-OS). +## HELYX-OS Installation for OpenFOAM v1606+ + +The steps for installing HELYX-OS are identical to the steps above with several additional steps to link to the existing v1606+ installation. + +13. Open the newly installed HELYX-OS and go to Edit>Preferences +14. In the "Misc" section check the "Use Docker" tick box and then type "openfoamplus/of_v1606plus_centos66" in the "Docker Image" textbox +15. Press "OK" to apply settings + +Please report all bugs encountered with HELYX-OS on the [project issue tracker](https://github.com/ENGYS/HELYX-OS/issues). + +## Compilation from Source +For the latest instructions on how to compile HELYX-OS from source, please see the git repository [README](https://github.com/ENGYS/HELYX-OS/blob/master/README.md) file inside the [HELYX-OS repository](https://github.com/ENGYS/HELYX-OS). Please report all bugs encountered with HELYX-OS on the [project issue tracker](https://github.com/ENGYS/HELYX-OS/issues).