User Tools

Site Tools


tutorials:setup-groimp-dev-environment

This is an old revision of the document!


Setup GroIMP with Git and Eclipse

In this tutorial we will cover how to:

  • Use Git to download GroIMP source code
  • Use Maven to compile the code
  • Set up Eclipse as IDE

You can find more in depth info on :

Installation of required tools

In this tutorial we will use the following software (make sure they are installed on your computer):

  • Git: On Linux system this is usually installed by default. On windows or MAC you can follow the tutorial from Github.
  • Maven: On Debian system you can get Maven with sudo apt install maven -y. On Windows, you can download the archive on the official website, unzip the file, and add it to the PATH variable.
  • Eclipse: For Debian systems you can follow the tutorial on the debian website: On Windows, you can download the installer from the eclipse website.

Download GroIMP source code

GroIMP source code is hosted on gitlab. It is split between the core - which includes the core plugin to start GroIMP (but not RGG modeling); and the additional plugins.

It is possible to download each gitlab repositories without creating accounts from the web page:

In order to properly push back modifications, it is recommended to get the sources using git. In order to do so, you need to have a GitLab account (which you can create here).

Once you are registered, you can fork the project: (see the two following images)

  • Go to the git repository page in your internet browser.
  • Click on the Fork button of the repository. (img 1)
  • Select your own gitlab namespace and optionally an other project name (not recommended). (img 2.1)
  • Only get the main branch (it is smaller) (img 2.2)
  • Click on Fork project.

 Ímage 1

Image 1

Image 2

Image 2

Add an ssh key to Gitlab

To skip the authentication for every git command to your gitlab repository, one way is to add an ssh key from your computer to your gitlab account

  1. On gitlab:
    1. Create a Gitlab account
    2. Fork the core repository
    3. create a access token for maven
  2. On your device
    1. install git
    2. clone core
    3. add maven key to m2 folder
    4. Build
  3. Eclipse
    1. install eclipse
    2. create new workspace
    3. import maven projects
    4. configure build
    5. add GPUFlux
tutorials/setup-groimp-dev-environment.1733336976.txt.gz · Last modified: 2024/12/04 19:29 by gaetan