build instructions

terminal

to build with mvn from the terminal:

• java development kit 8+ (known issues with Oracle's jdk 11)
• maven
• gurobi: install version 9, then register the jar added by gurobi with mvn install:install-file -Dfile=./gurobi.jar -DgroupId=local_gurobi -DartifactId=local_gurobi -Dversion=local_gurobi -Dpackaging=jar
• run mvn package for chordatlas
• the output jar appears in the target directory
• run with java -jar -Xmx10g chordatlas-0.0.1-SNAPSHOT.jar

if you are building mvn profile dev rather than release you will also need to:

• run mvn install for jutils, campskeleton, and siteplan

i develop with intellj and ubuntu. some relevant configuration files are in the repositories.

• main class is org.twak.tweed.TweedFrame
• the java ServiceLoader system is used to add plugins to the tweed core - additional projects (such as tweedstreets should be added in chordatlas' Run (or Debug) configurations in the classpath tab.

intelliJ

here is a video showing the later part of setting up the build in setting up the build in intellij.

docker

to build the binary (jar) with docker run these commands. The second will dump the output jar into the current directory

docker image build --tag chordatlas --file Dockerfile build

docker run -v ${PWD}:/output chordatlas update_and_export.sh

and run with (requires local, licensed, gurobi for bigSUR optimisation):

java -jar -Xmx10g chordatlas-0.0.1.jar

known issues

• if the 3D window is "shrunk", you can add the vm argument -Dsun.java2d.uiScale=1