-
Installing JDK 1.8+ (only tested with Oracle JDK) and Maven
- Mac OS X
- Run the following commands in the terminal:
brew tap caskroom/versions && brew cask install java8
.
- Run the following commands in the terminal:
- Archlinux / Manjaro
- Install Java 8+ if not already installed
- Something like 'sudo pamac install jdk8-openjdk'
- Switch to JDK environment
sudo archlinux-java set java-11-openjdk
- Install Java 8+ if not already installed
- Cent OS / Fedora
- Run the following commands in the shell
cd ~ && wget --no-cookies --no-check-certificate --header "Cookie: gpw_e24=http%3A%2F%2Fwww.oracle.com%2F; oraclelicense=accept-securebackup-cookie" "http://link_copied_from_site"
- After it is done downloading run
sudo yum localinstall jdk-8u161-linux-x64.rpm
. - At the prompt hit
y
andENTER
.
- Run the following commands in the shell
- Debian Based Linux (e.g. Ubuntu)
- Open up the terminal and enter
sudo add-apt-repository ppa:webupd8team/java && sudo apt-get update && sudo apt-get install oracle-java8-installer
.- Press
Enter
and accept the terms as necessary.
- Press
- Make sure the default java installion being used is correct (Java 8+).
- The easy way is to use
sudo apt install oracle-java8-set-default
. If you prefer to manually set it continue below. - Run
sudo update-alternatives --config java
in a terminal. - Select the appropriate java installation using a number.
- The easy way is to use
- Set your
JAVA_HOME
environment variable. This step is not always necessary but may be needed- Type
sudo nano /etc/environment
in the terminal. - This should open up an editor that allows you to edit the file (the editor doesn't matter but you will need su permissions to open the file).
- Append a line with
JAVA_HOME=
with the path to your java installation after, at the end of the file, similar toJAVA_HOME="/usr/lib/jvm/java-8-oracle"
- Reload the terminal and type
source /etc/environment && echo $JAVA_HOME
to test if the environment variable is pointing to the right location.
- Type
- Check that the correct java version is installed via
java -version
.- Should say something like
java version "1.8.0_191"
.
- Should say something like
- Install maven using the shell command
sudo apt-get install maven
. - Test that maven is installed using
mvn -version
. You should see something likeMaven home: /usr/share/maven
along with the various version numbers of Java printed out underneath that.
- Open up the terminal and enter
- Windows
- Go to https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html and download the appropriate version of the JDK
- Update the Windows PATH and JAVA_HOME environment variables.
- In the Control Panel select System.
- Then in the System window click Advanced and then Environment Variables
- Under System Variables find the PATH variable and append the path of the java installation to the end. It should look something like
C:\WINDOWS\system32;C:\WINDOWS;"C:\Program Files\Java\jdk-11\bin"
. Please note all variables must be separated by a semicolon. - Under System Variables again, create a new variable with the name
JAVA_HOME
and point it to the same JDK installation directory.
- Mac OS X
-
Install Maven
- Download the appropriate maven install zip file from https://maven.apache.org/download.cgi.
- This can also be done via
sudo apt-get install maven
in the terminal in Debian based systems.
- This can also be done via
- Unzip the file to any directory using your favorite program or
tar xzvf apache-maven-3.6.0-bin.tar.gz
in the terminal (with the appropriate version number). - Add the
bin
directory of the maven directory you unzipped to the WindowsPATH
variable. - Confirm that Maven is installed with
mvn -version
in the terminal.
- Download the appropriate maven install zip file from https://maven.apache.org/download.cgi.
-
Compiling and running the program
- In the root of the project compile the program using
mvn clean package
. - A compilied jar is in the project root for your convenience.
- Run the program using
java -jar jar-dir/slcsp-1.0.0-RELEASE.jar --zipcodes.path=zip-csv-path --plans.path=plan-csv-path --slcsp.path=slcsp-csv-path
- epxcted path format:
/path/to/thing
- jar-dir is the path to the jar file for execution
- if you are in the root of the project jar file will be in
target
- if you are in the root of the project jar file will be in
- zip-csv-path is the path to the CSV file with all the zipcodes and rate areas
- plan-csv-path is the path to the CSV file with all the plans and rates
- slcsp-csv-path is the path to the CSV file that contains the zipcodes you want to obtain rates for
- if all the files are in the same path as the jar it should look something like
java -jar ./slcsp-1.0.0-RELEASE.jar --zipcodes.path=./zips.csv --plans.path=./plans.csv --slcsp.path=./slcsp.csv
- epxcted path format:
- In the root of the project compile the program using