====== How to install the SVN-AMAPstudio version for the modellers ======

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

AMAPstudio software sources are hosted on a Subversion repository, these sources are available for the developers and modellers only (see the AMAPstudio charter).

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

<box 80% round blue |**Important note** >
If you are not already an AMAPstudio modeller and if you would like to integrate a model in AMAPstudio, please see [[whocanjoinamapstudio|Who can join the AMAPstudio project ?]], and contact the development team (see [[:contact]]) in order your registration to be validated.

</box>


==== 1. Install Java SE 8 (JDK)====

AMAPstudio relies on Java version 1.8 (or Java 8): Java Development Kit Standard Edition version 1.8.

**On windows**
  * Download an run a JDK 1.8 installer 
    * [[https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html|Try from here]] (e.g. Windows x86 for 32 bits systems) or look in [[https://www.oracle.com/java/technologies/javase/javase8-archive-downloads.html|these java 1.8 download archives]].

  * Modify the **PATH** environment variable according to your installation directory 
    *  Click Start > Control Panel > System on Windows XP or Start > Settings > Control Panel > System > Advanced > Environment Variables
    * In the ''PATH'' system variable, add the location of the bin/ folder of the installed JDK __at first position__. A typical value is: ''C:\Program Files\Java\jdk1.8.0_<version>\bin'' (you may seek this directory in a file manager and copy / paste the path)
    * A '';'' must be added between the paths in the ''PATH'' variable
    * You should only have one bin/ directory for a JDK in the path at a time. Those following the first instance will be ignored.

**On Linux**
   * Download a JDK installer
     * [[https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html|Try from here]] (e.g. Linux x64 for 64 bits systems)

If the PATH is to be updated, have a look in ''/etc/environment'', ''~/.bashrc'' or ''~/.profile''. You may have a look at this doc to [[https://help.ubuntu.com/community/EnvironmentVariables|change the PATH under Linux Ubuntu]].

-> To check if your installation of java is correct, [[faq|check the FAQ]].


==== 2. Create an amap-dev account====

AMAPstudio files are hosted on the //amap-dev// development server. To access to AMAPstudio 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 Jeeb / AMAPstudio project: https://amap-dev.cirad.fr/projects/jeeb and continue with point 3 below.


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

SmartSVN allows to access to SVN repository.

  * Download and Install SmartSVN: https://www.smartsvn.com/ (more downloads here: https://www.wandisco.com/subversion/download)
  * Start SmartSVN
      * //if Smartsvn asks 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/jeeb/trunk''
     * Local directory: the directory you choose for your local copy (e.g. C:\amapstudio OR /home/coligny/java/amapstudio)
  * 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

=== 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.

==== 5. Recompile and start AMAPstudio ====

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

  ant compile

  * If you need a full recompilation (should be done __after each update__)

  ant clean compile

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

  * Then you can launch the AMAPstudio applications.

**Example, launch Simeo**

The ''simeo.bat'' or ''simeo.sh'' scripts are used to start simeo :

Under Windows

  simeo 

Under Linux 

  sh simeo.sh