This repository has been archived on 2026-05-27. You can view files and clone it, but cannot push or open issues or pull requests.
HELYX-OS-Personal/README.md
HELYX-OS Development Team 03fc8a4e04 Update README.md
2016-01-22 16:49:18 +01:00

31 lines
1.7 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/).
## Compiling HELYX-OS on your own
### Prerequisites
- Installation of precompiled HELYX-OS X.X.X
- Oracle Java version > 1.7
- Oracle JDK
- Ant > 1.7
### Steps to Compile
1. Make sure the Oracle based java and JDK are installed in your machine (use `java -version` and `javac --version`) and configured correctly.
2. Navigate to the HELYX-OS directory (e.g. /home/user/Engys/HELYX-OS/vX.X.X)
3. Clone the HELYX-OS git repository
git clone https://github.com/ENGYS/HELYX-OS
4. Compile using the command
ant -buildfile build_src.xml
5. Run HELYX-OS with the command `./HELYX-OS.sh`
####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.