This is the easiest way, and is recommended for everyone.
|title||Oomph Setup on GitHub|
The following guide is no longer valid. Please use the setup instructions that are located in the wiki of the corresponding repository on GitHub.
If you are using an Eclipse installation for development on the Kieler project that was set up with the deprecated instructions, please consult this guide.
|title||Click here to expand the installation guide... (DEPRECATED)|
- Go to this site and download the Eclipse Installer for your platform. The site does not advertise that it ships the Oomph Eclipse Installer but downloading Eclipse with the orange download button will give you the installer.
- Start the installer. You should see something like this:
Click the Hamburger button at the top right corner and select Advanced Mode. Why? Because we're computer scientists, that's why!
Oomph now wants you to select which Eclipse distribution you want to use to develop KIELER in. Select the Eclipse Platform. Afterwards choose Latest Release as Product Version and click next.
Next, we need to tell Oomph how to setup an Eclipse ready for KIELER development. Click the Plus button at the top right corner. Select Eclipse Projects as Catalog and insert the following URL into the Resource URI field, then press OK.
This URL is no longer valid, see comment above.
In an earlier version of this site, you might be instructed to download the KIELER setup file and register the local file path. This setup file is now obsolete. Please do not use it anymore and register the new one. You might also want to remove it from the list and delete the downloaded setup file but this will cause errors in all Eclipse installations created with this setup. Hence, be careful and don't force me to say: I told you so!
Now Oomph lists a KIELER folder in <User>. Double-click on KIELER Pragmatics or KIELER Semantics to configure your setup. This will cause an item to appear in the table at the bottom of the window. The Stream column entry can be edited to choose on which state/branch you want to work. Once you're done, click Next.
Oomph now asks you to enter some more information. You can usually leave the settings as is, except for the Installation folder name. This will be the directory under which all your Eclipse installations installed with Oomph will appear, each in a separate sub-directory. Select a proper directory and click Next.
If do not have a Bitbucket Account or you are in a situation where you cannot access our Git via SSH, you need to adjust the Git URL! Make sure Show all variables is checked and replace the entry of KIELER Git URL by:
|title||But... I Already Have Git Repositories|
By default, the Oomph setup will clone all required Git repositories for each Eclipse installation, which takes up disk space and results in unnecessary duplication. You can change that by changing the Git clone location rule to Located in the specified absolute folder location and then setting the locations for each cloned repository accordingly.
Oomph will clone the repositories into the given folder, or use existing repositories.
|This is the part that veteran Eclipse developers will find strange. In the Oomph world, there is no one big Eclipse installation anymore. Instead, we simply use one installation for each project we're working on, completely self-contained in a folder that also contains the workspace and all required Git repositories. If something goes wrong, simply delete the whole folder and install a new Eclipse using Oomph.|
Having multiple Eclipse installations isn't even a problem in terms of disk space. Each installation is very lightweight, because all features and plug-ins used are saved in a centralized bundle pool (usually something like
~/.p2), which keeps each installation very small.
- Oomph now displays a summary of what will happen once you click Finish. Ignore it and click Finish.
- Once the basic installation is complete, your new Eclipse will start (at this point, you can safely close the Oomph dialog). Now, Oomph will try (and probably fail) to clone all required Git repositories. The Eclipse window will look something like this (once you've closed the Welcome page):
Note the icon at the bottom with the error marker. It tells you that something went wrong during the Oomph setup.
- The problem is that Eclipse doesn't know which SSH key to use to clone the repositories. Go to the Eclipse preferences and navigate to General -> Network Connections -> SSH2. Add the private key you want to use to connect to our repositories and click OK.
- You will now need to retry the failed Oomph setup steps. Either click on the Oomph setup icon at the bottom of the Eclipse window (if it's still there), or select Perform Setup Tasks from the Help menu. The dialog shows the failed setup tasks. Click Back, Next, and Finish to retry them all.