diff --git a/README.mb b/README.mb index f35dc4646d6e978fd7bae7fdbff3a10c4a0dd0a6..340fb7b02f42399fba46e470870a296d7abe51b1 100644 --- a/README.mb +++ b/README.mb @@ -1,3 +1,81 @@ -This software have been developped by SDC team from iCube Laboratory. +## Demo Video + +![Video](https://icube-forge.unistra.fr/lafabregue/Mustic/-/wikis/uploads/f8acb00bfa0804a2388a513849d4f3c5/MultIcubeVIDEO.mp4) + +## MutIcube Install : + +### Requirements : + +You will need java jre 1.8 or above (jdk is recommended) and git installed. + +Note that all commands are designed to work with unix bash. + +### Installation : + +##### Create a MutIcube directory and clone the four git project in it : +```bash + mkdir MultIcube + cd MultIcube + git clone https://icube-forge.unistra.fr/lafabregue/MultiCubeTools.git + git clone https://icube-forge.unistra.fr/lafabregue/JCL.git + git clone https://icube-forge.unistra.fr/lafabregue/JSL.git + git clone https://icube-forge.unistra.fr/lafabregue/Mustic.git +``` + +##### Open your favourite java IDE but it is recommended to use eclipse. The following instruction will be based on eclipse interface. + +* Change your workspace to the MultiCube directory +* Import the previous four projects into your IDE : + * Import > General > Projects from Folder or Archive + * Choose for each four projects the corresponding folder +* For each projet change its build path : + * JCL : add project MultiCubeTools + * JSL : add project MultiCubeTools + * Mustic : + * add project MultiCubeTools + * add project JCL + * add project JSL + * add the directory « resources » as Class Folder in Libraries build path + * change the Order of importation of ressources in the Order and Export tab to have + the two highlighted libraries on top : + +![image 1](doc/img/image1.png) + +* Add gdal external jars to the Mustic project : + +![image 2](doc/img/image2.png) + +* Run the mustic project : +Run > Java Application > +choose «MultiCube - mustic » among the different Main class +Use the Mustic/src/mustic/MultiCube.java if you don’t use eclipse +* Change the Run Configuration : + * add the two following Environment variables : + * Name : GDAL_DATA => Value: *../MultiCubeTools/share/* + * ***for linux only :*** + * Name : LD_LIBRARY_PATH => Value: *../MultiCubeTools/lib:./lib* + * ***for Windows and MacOS :*** + * add the following VM argument : -Djava.library.path=../MultiCubeTools/lib:./lib + * it is also recommended to change the memory allocated, by adding the VM arguments : + * -Xmsm -Xmxm + +On x64 unix platfrom you should normally be able to launch Mustic. +But if you import a picture and still have an error, or you want to use the project on MacOS +Windows, or x32 Unix you will have to change the dynamic libraries : +* For Windows : copy paste content of MultiCubeTools/lib/Windows/xx, xx beeing 64 or 32 +depending of your architecture +* For MacOS : copy paste content of MultiCubeTools/lib/MacOS + +If it does not fix your problem, you need to get the gdal binaries with java bidings : +* for Windows, you can refer to : +https://trac.osgeo.org/gdal/wiki/DownloadingGdalBinaries +* for Linux, you need to compile GDAL with the –with-java option, make the gdal-*/swig/java +sub-projet, and copy the resulting .so files and jar. For more details, you can refer to : +https://github.com/VertNet/reproject/wiki/GDAL-Java-Bindings (note that now there only one +.so file generated) +* for MacOS, the homebrew build no longer support the –with-java option, you need to +compile it yourself with the –with-java option, make the gdal-*/swig/java sub-projet, and +copy the resulting .so files and jar. For more details, you can refer to : +http://www.ecgs.lu/gilles/enabling-gdal-java-binding-for-geoserver-on-macos/ + -For installation refer to the "Install Guide MultiCube.pdf"