Installation¶
Pre-built Binaries¶
Note
This is the recommended way of installing for normal users.
Pre-built binaries are available from Maven Central. Download hyperSMURF-0.3 .jar from here.
Install from Source¶
Note
You only need to install from source if you want to develop hyperSMURF in Java yourself.
There are two options of installing hyperSMURF. The recommended way for most users is to download a prebuilt binary and is well-described in the Quickstart section. This section describes how to build hyperSMURF from scratch.
Prequisites¶
For building hyperSMURF, you will need
- Java JDK 8 or higher for compiling hyperSMURF,
- Maven 3 for building hyperSMURF, and
- Git for getting the sources.
Git Checkout¶
In this tutorial, we will download the hyperSMURF sources and build them in ~/hyperSMURF
.
~ # mkdir -p ~/hyperSMURF
~ # cd ~/hyperSMURF
hyperSMURF # git clone https://github.com/charite/hyperSMURF.git hyperSMURF
hyperSMURF # cd hyperSMURF
Maven Proxy Settings¶
If you are behind a proxy, you will get problems with Maven downloading dependencies.
If you run into problems, make sure to also delete ~/.m2/repository
.
Then, execute the following commands to fill ~/.m2/settings.xml
.
hyperSMURF # mkdir -p ~/.m2
hyperSMURF # test -f ~/.m2/settings.xml || cat >~/.m2/settings.xml <<END
<settings>
<proxies>
<proxy>
<active>true</active>
<protocol>http</protocol>
<host>proxy.example.com</host>
<port>8080</port>
<nonProxyHosts>*.example.com</nonProxyHosts>
</proxy>
</proxies>
</settings>
END
Building¶
You can build hyperSMURF using mvn package
.
This will automatically download all dependencies, build hyperSMURF, and run all tests.
hyperSMURF # mvn package
In case that you have non-compiling test, you can use the -DskipTests=true parameter for skipping them.
hyperSMURF # mvn install -DskipTests=true
Creating Eclipse Projects¶
Maven can be used to generate Eclipse projects that can be imported by the Eclipse IDE.
This can be done calling mvn eclipse:eclipse
command after calling mvn install
:
hyperSMURF # mvn install
hyperSMURF # mvn eclipse:eclipse