wiki:Documentation/DevelopmentCenter/DownloadAndBuildSource

Version 10 (modified by abeham, 5 years ago) (diff)

--

This quickstart covers how to obtain and set up the development environment in order to start extending HeuristicLab. The following points will be treated

  • Obtaining the source
  • Building HeuristicLab
  • Creating our own plugin
  • For the experienced

Obtaining the source

Here we will use the sources of the current stable build. The advantage is that these can be built without any prerequisites. You only require a current version of Visual Studio or SharpDevelop and the .NET framework.

  • Download the latest stable branch sources: Source zip
  • Unpack the archive into the folder HeuristicLab\stable somewhere on your hard drive

We will refer to the HeuristicLab folder as HLRoot, likewise we'll call the stable folder StableRoot. Please remember where HLRoot is located. The explorer should look like in the image to the right.

Building HeuristicLab

There are two important solutions in the StableRoot. The one that needs to be built first is called HeuristicLab.ExtLibs.sln. This will create a bin folder directly in StableRoot and add plugins of external libraries to which the rest of HeuristicLab depends upon. After this has been built successfully, HeuristicLab 3.3.sln will be used to build the main application. This will also add plugins and the HeuristicLab.exe into the common bin folder.

Using the Build.cmd script

If you have Visual Studio 2012 or later installed you can use the Build.cmd script in StableRoot.

  • Double click Build.cmd and type the number that is associated with the HeuristicLab.ExtLibs.sln

Then hit <Enter> and each time it prompts for configuration, platform and if a clean should be performed. It will then perform a Release build not specific to a CPU architecture.

  • Double click Build.cmd again and this time type the number associated with the HeuristicLab 3.3.sln solution.

Perform the same steps as above and the build should succeed. You now have built HeuristicLab into StableRoot\bin. We can now write our own plugin and link against these assemblies.

In the next section we will set up a new solution and add our own plugin.

Using an IDE

Building using Visual Studio or SharpDevelop is very simple and only requires that you build the solutions in the correct order. The HeuristicLab 3.3.sln is quite large, please be patient until it is loaded.

  • Open the solution file HeuristicLab.ExtLibs.sln and build it
  • Open the solution file HeuristicLab 3.3.sln and build it

Creating our own plugin

We now want to extend the functionality of HeuristicLab. For this purpose we add a new folder "extension" to the StableRoot.

For the experienced

At some point it might be beneficial for you to build against the code in our SVN repositories. The advantage is that you can update it and get new features as we release them. Also you will get notice of breaking changes to our API earlier. You'll have to install Tortoise SVN because the build process makes use of one of its tools (SubWCRev). You need to have the binary path (bin) of TortoiseSVN (usually C:\Program Files\TortoiseSVN\bin) in your PATH environment variable.

  • Check out the SVN repository of the stable branch at ​http://dev.heuristiclab.com/svn/hl/core/stable.

Attachments (2)

Download all attachments as: .zip