Installation

How to install and start using the toolkit

Introduction

Here we describe how to install and start using the toolkit (it's pretty simple!)

Download

Download the latest distribution; either (note: these distributions are suitable for all platforms):

1. v1.3.1 full distribution -- this is recommended for most users (includes jar file, javadocs, demonstrations, unit tests and build scripts); or
2. v1.3.1 jar only (use only if you don't need much guidance on how to use the toolkit);
3. git repository -- the bleeding edge, use only to stay right up to date, but be aware that compilation could break at any time -- see https://github.com/jlizier/jidt. See AntScripts for build instructions.

See all distributions and brief descriptions at Downloads.

Dependencies

None! You don't need any other downloads to start using this code in general.

There are only dependencies if:

1. You don't have java installed - download the Java SE / JDK. It's better to install the JDK (development kit) instead of JRE (runtime environment), since this will allow you to make Java code changes instead of only running the java code;
2. You wish to (re-)build the project (if you're changing the source files or using an svn checkout) using the build.xml script - this requires ant. See AntScripts for build instructions;
3. You wish to run the JUnit test cases - this requires JUnit - for how to run JUnit with our ant script see JUnitTestCases and AntScripts;
4. Additional preparation may be required to use JIDT in GNU Octave or Python; see UseInOctaveMatlab or UseInPython respectively.

Install

If you have one of the distributions:

1. Unzip the distribution to a location of your choice, and/or move the infodynamics.jar file to a relevant location. Ensure that infodynamics.jar is on the Java classpath when your code attempts to access it (see e.g. SimpleJavaExamples);
2. To update to a new version, simply copy the new distribution over the top of the previous one.

Otherwise, if you are running with the source code via git, see AntScripts regarding running ant to generate infodynamics.jar.

That's it.

Usage

See Documentation and Demos for some guided examples on getting started and using the code.