In this article, we explain how to install the binary packages and how to compile OpenWalnut yourself. If you have any troubles see the FAQ or contact us. Also have a look at the ReleaseNotes.
The OpenWalnut team provides several binary packages of the current OpenWalnut releases. Besides this, the NeuroDebian project also provides OpenWalnut. This section explains how to install the different binary packages.
Debian, Ubuntu, and other Debian-based Systems
Our packages are build using the NeuroDebian repository. This means, the packages we provide depend on third-party packages available in NeuroDebian.
You first need to setup the NeuroDebian repository. We, therefore, refer to the documentation at http://neuro.debian.net/#how-to-use-this-repository. Then update your package database by issuing
You now need to make a choice. Either use NeuroDebian's OpenWalnut build or directly use ours. The NeuroDebian build might be less up-to-date but the advantage of NeuroDebian is that you automatically get package updates.
Please note, that if you want to contribute you should install some more tools like the unit testing framework, Doxygen, etc... see DeveloperGuidelines for further details.
Getting the source code
Generally you have two options to get the source code: Either getting the latest development snapshot from a source code repository, or downloading an archive. If unsure, checkout from the repository, for which you will need to have Mercurial installed.
Download from repository [Recommended]
Checking out current development from the repository with Mercurial. For more information see Mercurial.
git clone http://source.openwalnut.org OpenWalnut
Now you should have a directory called OpenWalnut, change to it! Now you are in the default branch, which is the current development status, but you also may change to specific releases, e.g.
git checkout Release_X.Y.Z
You can query the possible releases by asking Mercurial which tags we provide:
Please note that this repository is not writable! If you want to contribute to our project look here.
Downloading an archive:
Download one of the source archives in our downloads section. Depending on your operating system you may now extract the source code from the command line via
tar xzf OpenWalnut_X.Y.Z.tar.gz
or by using a graphical tool, like 7-zip on Windows.
Now you should have a directory called OpenWalnut, change to it!
Compiling and run
If you installed all the prerequisites, building OpenWalnut from scratch is very easy:
cd buildcmake ../srcmakebin/openwalnut
Do you have multiple CPU cores? Due to cmake's build dependency management, you can issue make with the -j (jobs) parameter to specify how many parallel build jobs should be started. This can tremendously decrease build time. The following snippet shows how to start 8 parallel build jobs:
If you have installed doxygen, you can issue
cd buildmake docyour_browser ../doc/developer/html/index.html
Compiling on Mac OSX is basically the same as for Linux once all dependencies are installed. We highly recommend to use Homebrew as nearly all dependencies are available there and, most important, they are compatible with the new C++ stdlib from OSX 10.10.
On Windows, you need to use the MSYS2 environment. We do not support Visual Studio as its C++ compiler has certain limitations, causing OpenWalnut not to build properly.
For those of you who really want to use Visual Studio (from the bottom of their heart, with a deep love and a high frustration resistance), we left our old Visual Studio Guide in the history of this page: here.
If you get OpenWalnut working this way, please contact us and we will incorporate your solution into OpenWalnut.