Table of Contents

How to join the Xplo project

Xplo is part of the AMAPstudio project developped at the AMAP laboratory. In order to join the Xplo project and integrate their model(s) in Xplo, modellers should follow the next steps:

1. Who can join the Xplo project ?

The Xplo software can host various types of plants / trees fine architecture growth models, possibly linked to biophysical models (radiative balance, biomechanics…). The core part of the software is free to make it easy for partners to join Xplo.

Contact

Any interested scientist can contact the Xplo team to discuss the interest for him to become a Xplo modeller in accordance with the 'AMAPstudio charter'. This implies that the scientist will be helped to become a beginner developer to be able to do the integration job by himself with simple tools, with support at starting time and then when he needs help.

The Xplo developers are skilled in software development and not in modelling. The help will concern the integration of the model within the Xplo software and NOT the model creation by itself.

2. Accept the AMAPstudio charter

Xplo is a sub-project of the AMAPstudio project.

The AMAPstudio charter explains the roles and rules for all the members of the project. It must be read and accepted by all members.

3. Install Java SE 6 (JDK)

Under Windows:

Click Start > Control Panel > System on Windows XP or Start > Settings > Control Panel > System > Advanced > Environment Variables. Add the location of the bin/ folder (the 'java path') of the JDK into the 'System Variables' > PATH (or in case of trouble in the 'User Variables' > PATH).

A typical value for the 'java path' is:

C:\Program Files\Java\jdk1.6.0_<version>\bin

We suggest you add this 'java path' at the beginning of the 'system PATH', followed by a ';'

You should have a single bin/ directory for a single JDK in the path at a time. Those following the first instance are ignored. If one is already present, update it to jdk1.6.0_<version>\bin.

Under Linux:

Use your system installer (i.e. aptitude, apt-get, yum, urpmi…).

For instance, on Ubuntu :

sudo apt-get install sun-java6-jdk sun-java6-bin

4. Create an amap-dev account

Xplo files are hosted on the amap-dev development server. To access to these files, you need to create an account on the server.

Important note

If you are not already a Xplo modeller and if you want to integrate a model in Xplo, please contact the development team (see section 1: Who can join the Xplo project ?). Otherwise your registration will not be validated.

Register yourself on: https://amap-dev.cirad.fr/account/register.

Once your account has been validated by an administrator you can access to the Xplo project: https://amap-dev.cirad.fr/projects/show/Xplo

Your login/password will be used to access to SVN files, but also to manage Xplo on the amap-dev development server (e.g. ask for a bug correction / a new feature).

5. Get a local copy of the project (svn checkout)

There are different methods to get the source codes of Xplo.

5.1 SmartSVN (windows / linux / mac)

SmartSVN is a portable client written in Java to access to SVN repositories.

If SmartSVN asks for svnserve and svnadmin, click Cancel. During installation, SmartSVN will ask you if you want to evaluate the Pro version. You can ignore this message (it may begin 'pro' and turn to 'common' after a while).

Quick Checkout: URL: https://amap-dev.cirad.fr/svn/jeeb/trunk Local directory: the directory you choose for your local copy (e.g. C:\AMAPstudio OR /home/coligny/java/AMAPstudio)

Note: This is your new login password you entered when you registered on amap-dev

5.2 TortoiseSVN (windows only)

This SVN client fully integrates in the Windows file manager by adding SVN related options in the right-click menu for directories and files under SVN.

To get a local copy (checkout) of the AMAPstudio project:

5.3 Command line

svn checkout --username login https://amap-dev.cirad.fr/svn/jeeb/trunk AMAPstudio

5.4 Eclipse

For expert users only, no help provided here at this time.

6. Usual Operations

SVN update: you should update your local copy every time you start to work on your project (every morning ?). Updating often helps reduce the number of conflicts.

Complete project recompilation is needed after an update, see section 7.

SVN commit: sends your local modifications to the server. Do not hesitate to commit often (if the local compilation is ok) in order to avoid conflicts. (every evening ?)

Subversion generates a unique revision number after each commit. Then you can easily recover your project in a particular state (in case of problems or incompatibility) ⇒ update to a particular revision.

6.1 SmartSVN

To update your local copy…

To commit your changes…

6.2 TortoiseSVN

To update your local copy…

To commit your changes…

6.3 Command line

To update your local copy…

svn up

To commit your changes…

svn ci
// Enter a little message in english in the default editor, then Ctrl-O and Ctrt-X

7. Recompile AMAPstudio and start Xplo

// Windows
ant compile
// Linux and Mac
sh ant compile

If you need a full recompilation

// Windows
ant clean compile
// Linux and Mac
sh ant clean compile

Note: this recompilation should be done after each update. If there are errors, please contact the Xplo team.

The xplo.bat or xplo.sh scripts are used to start Xplo:

// Windows
xplo
// Linux and Mac
sh xplo.sh

Note: you may also use

ant run