Compiling from source

AptaSUITE is written in Java and uses maven to compile and to build executable jar files. In order to compile the latest version of AptaSUITE, please make sure than maven and git are installed on your system. Then, issue the following commands in the command line:

git clone https://github.com/drivenbyentropy/aptasuite.git
cd aptasuite
mvn install

This will create a zip file called aptasuite-x.y.z, where x.y.z corresponds to the current version of the master branch, in the target folder. After extracting its content to your folder of choice, you can now call AptaSUITE as follows:

java -jar /path/to/aptasuite-x.y.z.jar [options]

Please refer to the manual for all options and on how to use AptaSUITE properly.

Troubleshooting

In case you encounter an out of memory error similar to

[ERROR] GC overhead limit exceeded -> [Help 1]

or

[ERROR] Java heap space -> [Help 1]

or

[ERROR] unable to create new native thread -> [Help 1]

please try to increase the maximum heap size that maven can use.

On Unix and Mac platforms, set the following command line flags prior to running mvn package.

export MAVEN_OPTS="-Xmx1g -Xms1g"

For Windows, try

set MAVEN_OPTS=-Xmx1g -Xms1g

If you keep getting the error, you might need to adjust the maximum memory from 1g to a larger value.