============================================================== === XULU README (2010-02-10, Martin Schmitz) === === === === http://wald.intevation.org/projects/xulu/ === === http://wald.intevation.org/projects/schmitzm/ === ============================================================== This file contains some informations ... (1) about the XULU modelling platform (2) how to proceed after the first SVN checkout (3) about the folder structur of XULU (4) how to start XULU a) Requirements b) Start XULU from command line c) Start XULU from Eclipse (5) how to develop XULU ----------------------------------------------------------- (1) General informations about XULU ----------------------------------------------------------- XULU (eXtendable Unified Land Use Modelling Platform) is a stand-alone Java software which was designed as a part of my diploma thesis (Martin Schmitz, 2005, Institite of computer science, University of Bonn/Germany). The goal was the create a generic framework, which provides general functionalities needed for (simulation) modelling, without any relationship to a concrete model context: - data maintenance - data types - data import/export - data visualisation - GUI With these components implemented once (--> XULU) there is no further need to take into account during implementation of any model. The model designer and programmer can concentrate on implementing the model algorithm. The interfaces to the upper mentioned components are realised as plugins, so the field of application is not static. Because the close cooperation with the ZFL (Zentrum für Fernerkundung der Landoberfläche) and IMPETUS (http://www.impetus.de) the most plugins which are currently implemented are for land use modelling: - maintain raster and vector data (based on the Geotools Java library) - layer based geo visualisation (based on the Geotools Java library) - raster based models But generally - with implementing appropriate plugins - XULU can also be used for complete other application fields ----------------------------------------------------------- (2) Initialize XULU after the first SVN checkout ----------------------------------------------------------- The XULU folders contain multiple files to configure defaults for the XULU main application as well as for XULU plugins. Because the "normal" user defined changes on these files should not be updated in SVN, these configuration files are initially located in the "defaults" folder, instead of their "correct" location. Therefore after the first SVN checkout you have to call the initXulu.bat (on Windows systems) or initXulu.sh (on Linux systems: first call "chmod +x initXulu.sh" to make the file executable!!) once to copy the configuration files from the "defaults" folder to their expected locations. Afterwardst you can make changes on all config files without any unintended effect on the whole XULU community. The default behavior of "InitXulu.bat" is not to overwrite files if they already exist. In case of trouble (e.g. deleted or damaged config files) you can call InitXulu.bat /reset or InitXulu.bat /init (no overwrite confirmation!) to overwrite all configuration files with their defaults. NOTE: PLEASE DO NOT CHANGE (AND/OR COMMIT) FILES IN THE "DEFAULT" FOLDER!! ----------------------------------------------------------- (3) The folder structure of XULU ----------------------------------------------------------- main folder: The main folder contains some configuration files for the XULU main application as well as the startXulu.bat which can be used to start XULU from out of an development environment (like Eclipse): - InitXulu.bat: initializes the folder structure after the first SVN checkout (see (2)) - DefaultProperties: Defaults for XULU properties; after the first XULU start a new file "XuluProperties" is created with the user defined properties - registry.xif: contains the plugins used in XULU - readme.txt: this file :-) defaults: Contains default configuration files for the XULU main application and plugins. By calling "InitXulu.bat" (see (2)) these files are copied to the expected locations. NOTE: PLEASE DO NOT CHANGE (AND/OR COMMIT) FILES IN THIS FOLDER!! classes: Contains the compliled java classes of the XULU application and plugins. doc: Contains the JavaDoc for Xulu. Also the target folder of "makeDoc.bat" lib: Contains all the external libraries required to run/compile XULU. All JARs in this folder must be integrated in the Java classpath. dist: Contains the current version of the XULU classes as JAR so Xulu can be started without compile the source code for your own plugin: Contains configuration files for XULU plugins. src: Contains the java source code of the XULU application and plugins. Temp: Usually empty. Needed for temporary files. ----------------------------------------------------------- (4) How to start XULU ----------------------------------------------------------- a) Requirements --------------- Besides the external libraries in "lib" folder, it is required that the following components are installed on system: - JRE 1.6 - JAI 1.1.3 b) Start XULU from command line ------------------------------- To start XULU from command line there are 2 main variants: 1) "startXulu.bat /useXuluJar" (Default) uses the XuluModellingPlatform.jar and SCHMITZM.jar from the "lib" folder to run XULU. This option is recommended, if you only want to "use" XULU and not to develop. 2) "startXulu.bat /useXuluClasses" uses the "classes" folder to run XULU. Use this option, if you want to take your own changes (or plugin extension) take effekt. This option requires that - XULU is previously compiled to "classes" folder c) Start XULU from Eclipse -------------------------- t.b.c. Important: SCHMITZM must be integrated in Classpath with higher priority than Geotools ----------------------------------------------------------- (4) How to develop XULU ----------------------------------------------------------- t.b.c. =========================================================== http://wald.intevation.org/projects/xulu/ http://wald.intevation.org/projects/schmitzm/ ===========================================================