Developing models in Capsis with JDK 1.8 and Subversion (SVN)

Un résumé de la procédure en français est disponible.

This documentation is for Capsis modellers (according to the Capsis charter), it explains how to get a full local copy of Capsis on their computer to be able to add their own work in the platform.

The Capsis software sources are hosted on a Subversion (SVN) repository.

A Login is required (see section 2. below).

Important note

If you are not already a Capsis modeller and if you would like to integrate a model in Capsis, please see How to join Capsis and contact the development team (see contact) in order your registration to be validated.

1. Install Java SE 8 (JDK)

See the Java 8 installation page

2. Create an amap-dev account

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

Register yourself on : https://amap-dev.cirad.fr/account/register .
Once your account has been validated by an administrator you can access to the Capsis project: https://amap-dev.cirad.fr/projects/capsis

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

3. Get a local copy of the project (checkout)

SmartSVN makes it possible to access to the SVN repository.

Download and install SmartSVN : https://www.smartsvn.com/ (whatever version is ok, no later update needed)
In case, older version of SmartSVN are available here.

Start SmartSVN
- if Smartsvn ask for svnserve and svnadmin, click Cancel
- During installation, SmartSVN may ask you if you want to evaluate the Pro version. You can ignore this message
Choose Check out project from repository
Quick Checkout :
- URL: https://amap-dev.cirad.fr/svn/capsis/trunk
- Local directory: the directory you choose for your local copy (e.g. C:\capsis4 OR /home/coligny/java/capsis4)
Accept the server fingerprint if proposed
Enter your login and password

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

Validate and finish

Possible trouble

The checkout operation may fail after a while with an error message, e.g.

APR does not understand this error code ra_serf: The server sent a truncated HTTP response body

In this case, try to continue the operation this way in SmartSVN:

select the capsis4 (top level) directory in the 'Directories' panel,
Modify > Cleanup
Update

This should continue the process. This operation might be done several times in case your internet connection is not optimal.

4. SVN usual operations

Later when you will need to get the last changes of the server downloaded to your local copy, you will use SmartSVN and the Update command.

When you will have to upload your own changes onto the server, you will use the SVN Commit command.

You may ask for support to well understand the process when updating your local copy or commiting your changes the first time.

For more information on the SVN commands, see this doc: SVN update and commit.

5. Recompile and start Capsis

Open a terminal (Dos prompt under windows, shell under linux)
Go to the capsis4 directory with cd
Recompile the project

ant compile

If you need a full recompilation (should be done after each SVN update)

ant clean compile

Note : If there are errors, please contact the capsis team.

Then you can launch Capsis.

The capsis.bat or capsis.sh scripts are used to start capsis :

Under Windows:

capsis

Under Linux:

sh capsis.sh

Note : you can also use

ant run

6. Configure your editor

See code editor.

7. Other useful command

See ant.

Table of Contents