Install

Prerequisites for Installation

To install and run FERAL, ensure that you have the following prerequisites:

• Open JDK 17: Required for running the FERAL Kernel.
• Python 3.8.10 or higher: Necessary for the PythonAPI.

Optionally, if you wish to use the C-Client library, you will also need:

• GCC 8.4 or higher

Installation

The preferred way of using FERAL is through the FERAL PythonAPI, which is a wrapper around the Java implementation. While both versions are functionally identical, the Python version provides abstractions and general QoL improvements for developers.

Install Python Version

To install the PythonAPI, use the wheel with the following command:

pip install ./feral3gp-1.0.0-py3-none-any.whl

Installation from Repository

Alternatively, you can install FERAL from the PyPI repository using your access token:

pip install feral3gp --index-url https://<your_personal_token_name>:<your_personal_token>@erbenschell.iese.fraunhofer.de/api/v4/projects/1237/packages/pypi/simple

Install Java Version

The easiest way to include FERAL in your Java project is by using Maven. Alternatively, you can also link the .jar file directly.

To integrate FERAL using Maven, follow these steps:

1. Create or edit your settings.xml to add your access token and repository configuration:

   <settings xmlns="http://maven.apache.org/SETTINGS/1.1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.1.0 http://maven.apache.org/xsd/settings-1.1.0.xsd">
     <servers>
       <server>
         <id>feral-gitlab</id>
         <configuration>
           <httpHeaders>
             <property>
               <name>Private-Token</name>
               <value>[your_personal_token]</value>
             </property>
           </httpHeaders>
         </configuration>
       </server>
     </servers>
     <profiles>
       <profile>
         <id>feral</id>
         <repositories>
           <repository>
             <id>feral-gitlab</id>
             <url>https://erbenschell.iese.fraunhofer.de/api/v4/projects/1237/packages/maven</url>
           </repository>
         </repositories>
       </profile>
     </profiles>
   
     <activeProfiles>
       <activeProfile>feral</activeProfile>
     </activeProfiles>
   </settings>
   

2. Add FERAL as a dependency in your pom.xml:

   <dependency>
     <groupId>de.fraunhofer.iese</groupId>
     <artifactId>feral</artifactId>
     <version>1.0.0</version>
   </dependency>
   

Install FCAPI C-Client Library

To install the FCAPI C-Client Library, you can either link the binaries manually or use the conan repository.

To install via conan:

1. Add the FERAL GitLab repository:

   conan remote add feral_gitlab https://erbenschell.iese.fraunhofer.de/api/v4/projects/1237/packages/conan
   

2. Authenticate with your GitLab username or token:

   conan user [gitlab-username or token-username] -r feral_gitlab -p [token]
   

3. Modify the fcapi import in your conanfile.txt based on your system- Possible values are:

   • fcapi_windows_gnu_32
   • fcapi_windows_gnu_64
   • fcapi_windows_msvc_32
   • fcapi_windows_msvc_64
   • fcapi_linux_gnu_32
   • fcapi_linux_gnu_64

Example conanfile.txt

[requires]
fcapi_windows_gnu_64/7.2@de.fraunhofer.iese/feral
flatbuffers/2.0.0

[generators]
compiler_args