Quickstart

From AIBenchWiki

Jump to: navigation, search

This page is under construction. Another quick-start guide can be found in these slides.

Contents

Installation (Eclipse)

Here we will install the AIBench SDK to develop AIBench applications by using Eclipse. You can use your own development environment, and if you want add the manual to this wiki.

Download SDK

Download the AIBench SDK from the downloads page

Decompress the SDK file in some folder in your local disk.

Create a new project

Create a new Java Project and click 'Next'

Image:Aibenchsdkinstall_1.png

Give a name to the project and Select Create project from existing source

Image:Aibenchsdkinstall_2.png

In the next window, first select Allow output folders for source folders (see 1 in the next figure) and then change the output folder of the default plugin (the sampleplugin) by double clicking in its Output Folder setting (see 2 in the next figure). Set the output folder to plugins_bin/sampleplugin

Image:Aibenchsdkinstall_3.png Image:Aibenchsdkinstall_4.png

Click in 'Finish'. You should have a new project with this structure:

Image:Aibenchsdkinstall_5.png

Prepare the launch configuration

Lets start the AIBench application with only the sample plugin. You will need a Run configuration. Go to the Eclipse menu Run->Run... and the Run Configuration dialog brings up.

Hit the New launch configuration (see 1 in the figure) icon and give a name to your configuration (see 2 in the figure). Make sure that your new project is the one in the Project field (see 3 in the figure). Next, in the Main tab, give type es.uvigo.ei.aibench.Launcher in the Main class field.


Image:Aibenchsdkinstall_6.png

Go to the Arguments tab and type plugins_bin in the Program arguments field (see the next figure)

Image:Aibenchsdkinstall_7.png

Go to the Classpath tab, and first remove the default classpath entry in the User entries (see 1 and 2 in the figure). Next, select again the empty User entries and hit Add jars...

Image:Aibenchsdkinstall_8.png

Navigate into your project and look for the lib folder. Select all jars and hit 'OK'.

Image:Aibenchsdkinstall_9.png

Thats all, you can hit 'Run' and see AIBench working!

Image:Aibenchsdkinstall_10.png

Create your plugins

In order to develop your application functionality, you will need to create at least one plugin. NOTE: You can also modify the sampleplugin provided or create a new one.

Lets see how to create new plugins.

First go to your project properties by, for example, secondary click in your project root folder and hitting Properties.... In the Java build path section, choose Add a new folder

Image:Aibenchsdkinstall_11.png

Create a new folder under the plugins_src called, in example, myplugin and hit 'OK'

Image:Aibenchsdkinstall_12.png

You also need to configure the output folder of your new source folder. Edit it as you can see in the figure.

Image:Aibenchsdkinstall_13.png

Give a name under plugins_bin, like plugins_bin/myplugin

Image:Aibenchsdkinstall_14.png

Now you have finish. Finally, your plugin needs at least a plugin.xml file. You can start by copying the one in the sampleplugin, but remember to change its uid and name.

First elements

Under construction...

First operation

Under construction...

First datatype

Under construction...

First view

Under construction...

Customizing the user interface

Under construction...

Changing the default template

Under construction...

Adding custom input dialogs to operations

Under construction see Custom_Input_Dialogs

Complex datatypes

Under construction...

Personal tools
Documentation