- 1 How to participate?
- 2 Java
- 3 Eclipse Oomph
- 4 Basic Environment
- 5 Run OpenChrom from scratch
- 6 Daily Pull
- 7 Contribute
- 8 Development - best practices
How to participate?
OpenChrom Community Edition is an open source software for chromatography and mass spectrometry. Hence, you're invited to download, edit and extend the platform. The following tutorial gives you a short overview how to setup an appropriate development environment.
OpenChrom is based on Java. Hence, a JDK needs to be installed first.
Download the current JDK here: http://www.oracle.com/technetwork/java/javase/downloads
OpenChrom is compiled against JDK8. So OpenJDK8 or Oracle JDK8 are fine. Of course, you can use Oracle JDK8 to run OpenChrom. Here's a description how to install the Oracle JDK8 under Ubuntu.
sudo add-apt-repository ppa:webupd8team/java
sudo apt-get update
sudo apt-get install oracle-java8-installer
Don't forget to install openjfx when using OpenJDK
sudo apt-get install openjdk-8-jdk
sudo apt-get install openjfx
OpenJFX isn't packaged BOO#976102 so it is advised to use the Oracle JDK which includes JavaFX. RPM downloads are available from the Oracle Java Download site. See also the topic installing Java in the openSUSE Support Database for more information.
OpenChrom is based on Eclipse technology. First of all, please install the appropriate IDE to develop plugins for OpenChrom. Eclipse offers a technology, named Oomph, which makes the setup and installation of IDEs as easy as drinking a beer. Please download and execute the appropriate Oomph version for your plaform:
Please follow the instructions to install the basic environment.
Execute Eclipe Oomph:
Select the "Advanced Mode...":
Add user products:
Paste the following URL: https://update.openchrom.net/main/downloads/setups/net.openchrom.ide.setup
Select the use product "OpenChrom - IDE". Switch to simple mode:
Select the entry "OpenChrom - IDE":
Note: openSUSE users should choose /usr/java/latest/ instead of the default OpenJDK.
Wait while the IDE is installed on your computer:
Accept the certificates:
Launch the IDE:
Have a look at the "Eclipse Updater" messages. Access the dialog via the small icon in the footer toolbar:
Click on finish after all items have been installed:
Download / Install Target Platform
Download the platform bundles:
and unpack them into your eclipse folder where the README.TXT is located. You should have a tp_develop-4.6.x-local folder. Tell your unzip tool to simply overwrite folders. This is fine.
After the target platform has been unzipped, open the file "develop-4.6.x-local.target" and define this as the current target platform via "Set as Target Platform":
Run OpenChrom from scratch
After installing the basic environment, you'll then have the choice to fetch the complete source code or to run a user specific workspace.
Complete Source Code
Use this option if you'd like to modify the source code of OpenChrom.
Use the menu "Import..."
And select the "Team Project Set" item:
Paste the following URL: https://update.openchrom.net/main/downloads/setups/OpenChrom.psf:
Fetching all sources could take a while:
Select the OpenChrom product "openchrom.compilation.community.product" and press the button "Launch an Eclipse application":
Now you can run OpenChrom from scratch:
User Specific Workspace
Use the user specific workspace option if you only like to develop one or a few plugins for OpenChrom.
Go to the "Git" views list:
And select the "Git Repositories" view:
Use the "Git Repositories" to clone one or more specific repos you'd like to edit:
Paste the appropriate project URL:
Checkout the branches:
Import the needed branch into your workspace (it's the location where Eclipse Oomph has installed the IDE):
Everything is fine after fetching the source code:
Create a new run configuration via "Run Configurations...":
Add a new "Eclipse Application", name it "OpenChrom 1.2.x (Alder)" and select the product "net.openchrom.rcp.compilation.community.ui.product":
Now you can run OpenChrom from scratch:
Open the "Git Repositories" view and "Pull" all repos before you start to work.
The source code of OpenChrom is hosted at . There are currently several projects hosted at GitHub that belong to OpenChrom. Please create the following accounts if you'd like to participate in the development. If you just want to download the code and run OpenChrom, you can skip this section.
GitHub Account: 
Eclipse Account: 
Eclipse Contributor Agreement (login and follow the "Sign" link): 
Development - best practices
Format the source code on each save action.
Please use the scripts under org.eclipse.chemclipse.utils/scripts for your development.
./pull-projects.sh - run this script before you start to work on a feature ./status-projects.sh - run this script before you finish your work (the workspace must be clean before you leave it)
Please develop in short cycles and try to pull/push as often as possible. Finish your work within 1 day. Otherwise, split your work in to smaller pieces.
OpenChrom is under active development. Thus plugin and package names may be refactored from time to time. After getting the latest updates (git pull) a workspace refresh may displays the following message:
Accept "Yes" and re-import the plugins/packages in the following way "Git Repositories -> Select Repo -> Import Projects...":
Delete workspace repo
If you'd like to delete a repo completely, do the following steps:
Import workspace repo
Clone a repo in the following way. Select the "develop" branch and ensure that the code is cloned into the workspace.