HELYX-OS/README.md
HELYX-OS Development Team 86a71e9c49 Update README.md
2016-01-21 18:17:50 -06:00

22 lines
1.4 KiB
Markdown

# HELYX-OS
[HELYX-OS](http://engys.com/products/helyx-os) is an open-source Graphical User Interface designed to work natively with OpenFOAM [version 2.4.0](http://www.openfoam.org/archive/2.4.0/download/source.php). The GUI is developed by [ENGYS](http://engys.com/) using Java+[VTK](http://www.vtk.org/) and delivered to the public under the GNU General Public License.
HELYX-OS has been created to facilitate the usage of the standard OpenFOAM libraries, by removing the complexity of text based case definition in favour of an intuitive easy-to-use graphical user interface. The GUI is focused on pre-processing tasks, including meshing, case definition and solver execution.
## Installing the latest binary file for 64 bit linux
Visit [http://engys.github.io/HELYX-OS/](http://engys.github.io/HELYX-OS/) to download the latest HELYX-OS binary and view [installation instructions](http://engys.github.io/HELYX-OS/installation/).
## Building HELYX-OS from source
### Prerequisite Libraries
### Steps to Compile
1. Ensure all prerequisite libraries are installed
2. Clone the HELYX-OS git repository locally
git clone https://github.com/ENGYS/HELYX-OS
3. Navigate to the HELYX-OS directory
####Disclaimer
None of the OPENFOAM® related products and services offered by ENGYS are approved or endorsed by OpenCFD Ltd. (ESI Group), producer of the OpenFOAM software and owner of the OPENFOAM® and OpenCFD® trade marks.