Wiki » History » Version 84

Komenda Antonín, 11/07/2012 04:19 PM

1 1 Komenda Antonín
h1. Alite
2 2 Komenda Antonín
3 76 Komenda Antonín
*Alite* _[’eilait]_ is a software toolkit helping with particular implementation steps during construction of multi-agent simulations and multi-agent systems in general. The goals of the toolkit are to provide highly _modular_, _variable_, and _open_ set of functionalities defined by clear and simple API. The toolkit does not serve as a pre-designed framework for a complex purpose, it rather associates number of highly refined functional elements, which can be variably combined and extended into a wide spectrum of possible systems. Alite is licensed under "LGPL3":http://www.gnu.org/licenses/lgpl-3.0.en.html.
4 9 Komenda Antonín
5 73 Komenda Antonín
{{>toc}}
6 73 Komenda Antonín
7 17 Komenda Antonín
h2. Documentation
8 1 Komenda Antonín
9 61 Komenda Antonín
h3. Alite Main
10 61 Komenda Antonín
11 17 Komenda Antonín
* [[Alite Overview]]
12 64 Komenda Antonín
* "JavaDoc":http://jones.felk.cvut.cz/alite-javadoc
13 66 Komenda Antonín
** "Vis3D module JavaDoc":http://jones.felk.cvut.cz/alite-vis3d-javadoc
14 42 Komenda Antonín
* [[Alite FAQ]]
15 17 Komenda Antonín
16 24 Komenda Antonín
* [[Alite and Aglobe]]
17 25 Komenda Antonín
* [[Synchronized Visualization]]
18 23 Komenda Antonín
19 60 Komenda Antonín
h3. Modules
20 46 Komenda Antonín
21 59 Komenda Antonín
* [[Template Groovy Configurator]] _(configurator/templategroovy)_
22 68 Komenda Antonín
* [[Trajectory Tools]] _(trajectorytools)_
23 59 Komenda Antonín
* [[KML Visio]] _(kmlvisio)_
24 65 Komenda Antonín
* [[Vis 3D]] _(vis3d)_
25 78 Komenda Antonín
* [[Aglobe Adapter]] _(aglobeadapter)_
26 77 Komenda Antonín
27 1 Komenda Antonín
Experimental:
28 79 Komenda Antonín
* [[Config Reader]] _(configreader)_
29 72 Komenda Antonín
* [[NetEmu]] _(netemu)_
30 66 Komenda Antonín
31 70 Komenda Antonín
h2. Conventions
32 1 Komenda Antonín
33 70 Komenda Antonín
h3. Feature Acceptance Process
34 2 Komenda Antonín
35 2 Komenda Antonín
* docs - javadoc, usage examples
36 1 Komenda Antonín
* tests - testing usage examples, testing complete documented functionality 
37 26 Komenda Antonín
* design compliance - loosely coupling, API centric
38 26 Komenda Antonín
39 63 Komenda Antonín
h3. Code ("Eclipse Formatter":http://jones.felk.cvut.cz/redmine/attachments/download/46/eclipse_formatter.xml)
40 26 Komenda Antonín
41 26 Komenda Antonín
* indentation: 4 spaces
42 26 Komenda Antonín
* no trailing whitespaces
43 26 Komenda Antonín
* coding style: http://java.sun.com/docs/codeconv/
44 36 Komenda Antonín
* maximum line width: 100
45 26 Komenda Antonín
* no standard Eclipse warnings and errors in cz.agents.alite package
46 84 Komenda Antonín
* no standard Eclipse errors in experimental modules (warnings are tolerated in experimental modules)
47 26 Komenda Antonín
48 27 Komenda Antonín
h3. Committing
49 26 Komenda Antonín
50 26 Komenda Antonín
* small atomic commits (logically bounded change)
51 26 Komenda Antonín
* commit whole branch
52 54 Komenda Antonín
* for larger changes in cz.agents.alite package do special branch
53 26 Komenda Antonín
* always use commit message
54 26 Komenda Antonín
* commit message has format: 
55 26 Komenda Antonín
<pre>
56 28 Komenda Antonín
One line of commit summary (fixes #XYZ)
57 26 Komenda Antonín
58 28 Komenda Antonín
Optionally explanation of the commit details.
59 1 Komenda Antonín
</pre>
60 54 Komenda Antonín
* if a commit fixes a redmine issue, add (fixes #XYZ) and redmine will automatically mark it as fixed (if the commit does not fix anything in redmine do not add (fixes #XYZ) into commit message)
61 34 Komenda Antonín
* in case of (fixes #XYZ), the commit summary should copy the title of the issue #XYZ
62 35 Komenda Antonín
* do not commit any commented-out code
63 1 Komenda Antonín
64 4 Komenda Antonín
65 4 Komenda Antonín
h2. Version Schema
66 4 Komenda Antonín
67 45 Komenda Antonín
major.minor(.revision|-SNAPSHOT)
68 2 Komenda Antonín
69 2 Komenda Antonín
* major = complete redesign (major API changes - no backward compatibility)
70 1 Komenda Antonín
* minor = larger changes/cumulated changes (minor API changes - as most as possible of backward compatibility, simply describable code migration process, e.g. method naming)
71 1 Komenda Antonín
* revision = fixes, new features (only compatible API changes - full backward compatibility)
72 45 Komenda Antonín
* SNAPSHOT = newest snapshot of major.minor version
73 4 Komenda Antonín
74 4 Komenda Antonín
75 6 Komenda Antonín
h2. Repositories
76 1 Komenda Antonín
77 41 Komenda Antonín
On Mercurial ([[Mercurial|Mercurial on Smith tutorial]]):
78 41 Komenda Antonín
* *Alite main* - ssh://USER@smith.felk.cvut.cz//data/hg/alite
79 80 Komenda Antonín
** *Configurators*
80 80 Komenda Antonín
*** *Template Groovy Configurator sources* - ssh://USER@smith.felk.cvut.cz//data/hg/alite/configurator/templategroovy
81 69 Komenda Antonín
** *Trajectory Tools* - ssh://USER@smith.felk.cvut.cz//data/hg/alite/trajectorytools
82 47 Komenda Antonín
** *KML Visio module sources* - ssh://USER@smith.felk.cvut.cz//data/hg/alite/kmlvisio
83 47 Komenda Antonín
*** *Customized JAK module sources* - ssh://USER@smith.felk.cvut.cz//data/hg/alite/kmlvisio/customjak
84 65 Komenda Antonín
** *Vis 3D module sources* - ssh://USER@smith.felk.cvut.cz//data/hg/alite/vis3d
85 1 Komenda Antonín
** *Aglobe Adapter sources* - ssh://USER@smith.felk.cvut.cz//data/hg/alite/aglobeadapter
86 81 Komenda Antonín
87 82 Komenda Antonín
* *Alite experimental*
88 81 Komenda Antonín
** *Config Reader sources* - ssh://USER@smith.felk.cvut.cz//data/hg/alite/configreader
89 72 Komenda Antonín
** *NetEmu sources* - ssh://USER@smith.felk.cvut.cz//data/hg/alite/netemu
90 12 Jakob Michal
91 55 Komenda Antonín
* *Alite documents* - ssh://USER@smith.felk.cvut.cz//data/hg/alite/doc
92 55 Komenda Antonín
93 15 Jakob Michal
h2. Blueprints
94 14 Jakob Michal
95 13 Jakob Michal
Strategic areas of development:
96 13 Jakob Michal
* Reporting and Visualization -- post-analysis, replay, debugging support etc.
97 12 Jakob Michal
* Communication -- low-level (transport etc.) vs. high-level (protocols etc.)
98 13 Jakob Michal
* Agent Control (behavior modularization) -- activities vs. actions, agent memory etc.
99 13 Jakob Michal
* Graph/Network Environments -- representation of graph-based environments (streetnetworks etc.)