Skip to content

Setting up developer environment

mquinson edited this page Oct 3, 2014 · 29 revisions

Retrieving the source code

One solution is to simply clone our git repository, for example by typing "git clone [email protected]:oster/PLM.git" on the command line. But this is somehow cumbersome as you will have to deal with the git interface by yourself. In particular, when you change something, you have to extract the diff by yourself and send it per email.

An easier solution is to create an account on the github interface (make sure to read the TOS to check if they are acceptable to you), and fork our repository on your account. That way, you will benefit of all the neat tools provided by github. Check the github documentation for more information. While you are at it, consider starring PLM ;)

Eclipse set up

The PLM is written in several programming language, so you need to install all the java, python and scala nature in eclipse to get it working. The scala nature (that you can get from the Scala plugin for eclipse) is very important as it is used to compile most of the project. There is no need to install the C nature as eclipse never gets to compile these files (the PLM does it itself on need).

One trick is that we insist on using the libraries that are located in lib/ instead of the ones on disk. This is because the lib/ ones are distributed in the generated archives, so we want to check that the code actually works with these versions. Eclipse sometimes tries to be cleaver here and use "better" versions of the libraries, so please inspect any change that you commit to the .classpath and .project files very carefully.

To test your code from eclipse, simply launch the classes containing a main as Java application.

The distributed archives are generated from the ant file (build.xml). It used to work from eclipse too, but not anymore. If you know how to fix it, we'd love to hear from you.