xulu/trunk/readme.txt

TODO:
- startXulu.bat erweitern:
   - /useXuluClasses auf SCHMITZM erweitern
- SCHMITZM in Xulu\lib aufnehmen
- How to start XULU from Eclipse
- How to develop XULU

==============================================================
=== XULU README (2009-02-24, 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 themodel algorithm.
The interfaces to the upper mentioned components are realised as plugins,
so the field of application is not static.
Because the of 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" position.

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. After that 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.

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
      - SCHMITZM is previously compiled to

c) Start XULU from Eclipse
--------------------------
t.b.c.


-----------------------------------------------------------
(4) How to develop XULU
-----------------------------------------------------------
t.b.c.


===========================================================
http://wald.intevation.org/projects/xulu/
http://wald.intevation.org/projects/schmitzm/
===========================================================
1	TODO:
2	- startXulu.bat erweitern:
3	- /useXuluClasses auf SCHMITZM erweitern
4	- SCHMITZM in Xulu\lib aufnehmen
5	- How to start XULU from Eclipse
6	- How to develop XULU
7
8	==============================================================
9	=== XULU README (2009-02-24, Martin Schmitz) ===
10	=== ===
11	=== http://wald.intevation.org/projects/xulu/ ===
12	=== http://wald.intevation.org/projects/schmitzm/ ===
13	==============================================================
14	This file contains some informations ...
15
16	(1) about the XULU modelling platform
17	(2) how to proceed after the first SVN checkout
18	(3) about the folder structur of XULU
19	(4) how to start XULU
20	a) Requirements
21	b) Start XULU from command line
22	c) Start XULU from Eclipse
23	(5) how to develop XULU
24
25
26
27	-----------------------------------------------------------
28	(1) General informations about XULU
29	-----------------------------------------------------------
30	XULU (eXtendable Unified Land Use Modelling Platform) is a stand-alone
31	Java software which was designed as a part of my diploma thesis (Martin Schmitz,
32	2005, Institite of computer science, University of Bonn/Germany).
33	The goal was the create a generic framework, which provides general functionalities
34	needed for (simulation) modelling, without any relationship to a concrete
35	model context:
36	- data maintenance
37	- data types
38	- data import/export
39	- data visualisation
40	- GUI
41
42	With these components implemented once (--> XULU) there is no further need to
43	take into account during implementation of any model. The model designer and
44	programmer can concentrate on implementing themodel algorithm.
45	The interfaces to the upper mentioned components are realised as plugins,
46	so the field of application is not static.
47	Because the of the close cooperation with the ZFL (Zentrum für Fernerkundung der
48	Landoberfläche) and IMPETUS (http://www.impetus.de) the most plugins which
49	are currently implemented are for land use modelling:
50	- maintain raster and vector data (based on the Geotools Java library)
51	- layer based geo visualisation (based on the Geotools Java library)
52	- raster based models
53
54	But generally - with implementing appropriate plugins - XULU can also be used for
55	complete other application fields
56
57
58	-----------------------------------------------------------
59	(2) Initialize XULU after the first SVN checkout
60	-----------------------------------------------------------
61	The XULU folders contain multiple files to configure defaults for
62	the XULU main application as well as for XULU plugins.
63	Because the "normal" user defined changes on these files should not be
64	updated in SVN, these configuration files are initially located in the
65	"defaults" folder, instead of their "correct" position.
66
67	Therefore after the first SVN checkout you have to call the
68
69	initXulu.bat (on Windows systems)
70	or initXulu.sh (on Linux systems: first call "chmod +x initXulu.sh"
71	to make the file executable!!)
72
73	once to copy the configuration files from the "defaults" folder to their
74	expected locations. After that you can make changes on all config files
75	without any unintended effect on the whole XULU community.
76
77	The default behavior of "InitXulu.bat" is not to overwrite files if they
78	already exist. In case of trouble (e.g. deleted or damaged config files)
79	you can call
80	InitXulu.bat /reset
81	or InitXulu.bat /init (no overwrite confirmation!)
82
83	to overwrite all configuration files with their defaults.
84
85	NOTE: PLEASE DO NOT CHANGE (AND/OR COMMIT) FILES IN THE
86	"DEFAULT" FOLDER!!
87
88
89	-----------------------------------------------------------
90	(3) The folder structure of XULU
91	-----------------------------------------------------------
92	main folder: The main folder contains some configuration files for
93	the XULU main application as well as the startXulu.bat
94	which can be used to start XULU from out of an
95	development environment (like Eclipse):
96	- InitXulu.bat: initializes the folder structure after
97	the first SVN checkout (see (2))
98	- DefaultProperties: Defaults for XULU properties; after
99	the first XULU start a new file
100	"XuluProperties" is created with the
101	user defined properties
102	- registry.xif: contains the plugins used in XULU
103	- readme.txt: this file :-)
104
105	defaults: Contains default configuration files for the XULU main
106	application and plugins. By calling "InitXulu.bat" (see (2))
107	these files are copied to the expected locations.
108	NOTE: PLEASE DO NOT CHANGE (AND/OR COMMIT) FILES IN
109	THIS FOLDER!!
110
111	classes: Contains the compliled java classes of the XULU application
112	and plugins.
113
114	doc: Contains the JavaDoc for Xulu. Also the target folder of
115	"makeDoc.bat"
116
117	lib: Contains all the external libraries required to run/compile XULU.
118	All JARs in this folder must be integrated in the Java classpath.
119
120	plugin: Contains configuration files for XULU plugins.
121
122	src: Contains the java source code of the XULU application and plugins.
123
124	Temp: Usually empty. Needed for temporary files.
125
126
127	-----------------------------------------------------------
128	(4) How to start XULU
129	-----------------------------------------------------------
130
131	a) Requirements
132	---------------
133	Besides the external libraries in "lib" folder, it is required that
134	the following components are installed on system:
135	- JRE 1.6
136	- JAI 1.1.3
137
138	b) Start XULU from command line
139	-------------------------------
140	To start XULU from command line there are 2 main variants:
141
142	1) "startXulu.bat /useXuluJar" (Default)
143	uses the XuluModellingPlatform.jar and SCHMITZM.jar from the
144	"lib" folder to run XULU. This option is recommended, if you
145	only want to "use" XULU and not to develop.
146
147	2) "startXulu.bat /useXuluClasses"
148	uses the "classes" folder to run XULU. Use this option, if you
149	want to take your own changes (or plugin extension) take effekt.
150	This option requires that
151	- XULU is previously compiled to "classes" folder
152	- SCHMITZM is previously compiled to
153
154	c) Start XULU from Eclipse
155	--------------------------
156	t.b.c.
157
158
159	-----------------------------------------------------------
160	(4) How to develop XULU
161	-----------------------------------------------------------
162	t.b.c.
163
164
165	===========================================================
166	http://wald.intevation.org/projects/xulu/
167	http://wald.intevation.org/projects/schmitzm/
168	===========================================================