Adding some internal doc

Author: mbrasebin

README.md

@@ -10,15 +10,26 @@ This software is free to use under CeCILL license. However, if you use this libr
 Furthermore, we are interested in every feedbacks about this library if you find it useful, if you want to contribute or if you have some suggestions to improve it.
 
 
+Distribution method
+---------------------
+The zonepacker script allow to split parcels into homogeneous groups in term of number of simulation for calculation distribution with OpenMOLE. In order to run this script, an OSGI bundle have to be built by using *sbt osgiBundle* command from the root of the projet.
+
+The resulting bundle has to be placed in the same directory than the script and can be run by updating the reference to the different folders.
+ ./zonepacker.sh "/home/mbrasebin/Bureau/parcels_rulez/real/parcels_rulez.shp" "/tmp/tmp/" "/tmp/out/" 20
+
+The folder produced by this process can be used to be distributed with OpenMole, a template with the script is available in the release of this project. You only have to paste the folders in a subfolder of dataBasicSimu folder and to add the osgi bundle as an OpenMole plugin.
+
+
 Exploration method
 ---------------------
 Using the Pattern Search Exploration (PSE) method allows the production of diversity of simulation models outputs. This methods is applied on SimPLU3D model in order to generate a variety of built configurations according to external measure (density, distribution of height, etc.).
 
+
 [More information, implementation and results are provided in the dedicated branch (results_pse)](https://github.com/IGNF/simplu3D-openmole/tree/results_pse)
 
 Contact for feedbacks
 ---------------------
-* [Mickaël Brasebin](http://recherche.ign.fr/labos/cogit/cv.php?nom=Brasebin) 
+* [Mickaël Brasebin](http://recherche.ign.fr/labos/cogit/cv.php?nom=Brasebin)
 * [Julien Perret](http://recherche.ign.fr/labos/cogit/cv.php?prenom=Julien&nom=Perret)
 * [Paul Chapron](https://scholar.google.com/citations?user=EHGHwR8AAAAJ&hl=en)
 

script/zonepacker.sh

@@ -1,19 +1,15 @@
 #!/bin/bash
 
-#Parcel shapefile
-parcelfile="/home/mbrasebin/Bureau/parcels_rulez/real/parcels_rulez.shp"
+#Memory arguments
+javaargs="-Xms8156m -Xmx8156m -XX:PermSize=512m -XX:MaxPermSize=512m"
 
-#Temporary folder (has to be empty)
-tempfolder="/tmp/tmp/"
+#First argument : Parcel shapefile "/home/mbrasebin/Bureau/parcels_rulez/real/parcels_rulez.shp"
 
-#OutputFolder
-outfolder="/tmp/out/"
+#Second argument : temporary folder (must be empty) "/tmp/tmp/"
 
-#Nuber of simulable parcels per final package
-numberofsimulbypackage=20
+#Third argument folder out "/tmp/out/"
 
-#Mememory arguments
-javaargs="-Xms8156m -Xmx8156m -XX:PermSize=512m -XX:MaxPermSize=512m"
+#Forth argument : the number of simulable parcel by package 20
 
-java $javaargs -cp simplu3d-openmole-plugin_2.12-1.0.jar fr.ign.simplu3d.ZonePackerExecIAUIDF $parcelfile  $tempfolder $outfolder $numberofsimulbypackage
+java $javaargs -cp simplu3d-openmole-plugin_2.12-1.0.jar fr.ign.simplu3d.ZonePackerExecIAUIDF $*