Add HeFQUIN as a dependency to your Maven project

The HeFQUIN engine can be used directly from within your Java code. Assuming that your Java code is maintained as a Maven project, you need to add HeFQUIN as a dependency in the POM file of your Maven project, which you can do

for one of the available releases of HeFQUIN or
for the current developer version in the HeFQUIN source code repository.

Thereafter, you can write Java code that instantiates and uses the engine.

Use an Available Release

For each of the HeFQUIN releases we publish the relevant artifacts via Maven Central. Therefore, all you need to do to add a particular release version of HeFQUIN as a dependency for your Maven project is to add the following snippet to the dependencies section of your POM file and change the given version number to the version number of the HeFQUIN release you want to use.

<dependency>
    <groupId>se.liu.research.hefquin</groupId>
    <artifactId>hefquin-engine</artifactId>
    <version>0.0.1</version> <!-- replace this by the version number of the HeFQUIN release to be used -->
</dependency>

Now you may run the following command in your Maven project to compile the project with the new dependency (or you refresh/reimport your Maven project in the IDE that you are using).

mvn clean compile

Use a Version of the Source Code

If you want to use the current developer version of HeFQUIN instead, you need a local clone of the GitHub repository of HeFQUIN.

If you have not cloned the repository already, you can clone it either by using the SSH URL:

git clone git@github.com:LiUSemWeb/HeFQUIN.git

or by using the HTTP URL:

git clone https://github.com/LiUSemWeb/HeFQUIN.git

If you have cloned the repository earlier, make sure that you pull the latest version of the source code into your local clone:

git checkout main
git pull

Within the directory into which you have cloned the repo, you can now run the following command to compile the HeFQUIN source code using Maven and publish the relevant artifacts to your local maven repository.

mvn clean install

Assuming the build finishes successfully, you can now add the developer version of HeFQUIN as a dependency for your own Maven project, for which you need to add the following snippet to the dependencies section of the POM file of your Maven project and change the given version number to the version number of the HeFQUIN artifacts that you have just built.

<dependency>
    <groupId>se.liu.research.hefquin</groupId>
    <artifactId>hefquin-engine</artifactId>
    <version>0.0.1-SNAPSHOT</version> <!-- replace this by the version number currently used by the HeFQUIN source code -->
</dependency>

Now you may run the following command in your Maven project to compile your project with the new dependency (or you refresh/reimport your Maven project in the IDE that you are using).

mvn clean compile