AlgoQuant Setup

1. AlgoQuant Setup
   1. Initial Setup
      1. NetBeans
      2. Eclipse
   2. Configuration File
   3. Project License

Initial Setup

AlgoQuant uses ​Maven for project management. To download and install required libraries, you need to do an initialization step.

NetBeans

In NetBeans, open the parent project algoquant and click Build:

Then, NetBeans will install the required jar files into your local maven repository and run all the tests automatically.

Reference: ​http://wiki.netbeans.org/MavenBestPractices

Eclipse

In Eclipse, import the parent project. Then, Eclipse may install the required maven plugins and restart. After Eclipse restarts, you need to run Maven install for the sub-project algoquant-install-jars to install the required jar files into your local maven repository.

Then, go to Project > Clean… to clean all the algoquant projects to let Eclipse refresh the projects’ statuses. Now, you can run the JUnit tests in algoquant-core and algoquant-demo to check if everything is properly initialized.

Reference: ​http://www.sonatype.com/books/m2eclipse-book/reference/index.html

With the proper setup, you can start coding with AlgoQuant API.

Configuration File

The default configuration file is algoquant/core/src/main/resources/config/config.default.xml. If you would like to modify the settings (e.g., location of data files), you can edit the file data.properties under the same directory.

Alternatively, you can create your custom-made configuration folder and files as in folder haksunli, and define the system property config in your Java environment, e.g., -Dconfig=haksunli/config.haksunli.xml in NetBeans IDE. You can put the configuration files under the core/src/main/resources/config folder or any location in the classpath.

Project License

All our projects use the NumericalMethod license. For NetBeans users, when creating a new file in the project algoquant, you may see this error in the first line of the new file.

Error reading included file Templates/Classes/../Licenses/license-NumericalMethod.txt

There are two options. You may choose to ignore them and delete this line each time you open a new file. Alternatively, you can comment out this line in the project POM file (algoquant/pom.xml):

<netbeans.hint.license>NumericalMethod</netbeans.hint.license>