Wiki » History » Version 88

Komenda Antonín, 08/22/2013 11:28 AM

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 87 Vokřínek Jiří
22 87 Vokřínek Jiří
* [[trajectorytools:|Trajectory Tools]] _(trajectorytools)_
23 88 Komenda Antonín
* [[Config Reader]] _(configreader)_
24 85 Komenda Antonín
* [[Template Groovy Configurator]] _(configurator/templategroovy)_
25 59 Komenda Antonín
* [[Vis 3D]] _(vis3d)_
26 85 Komenda Antonín
* [[KML Visio]] _(kmlvisio)_
27 78 Komenda Antonín
* [[Aglobe Adapter]] _(aglobeadapter)_
28 77 Komenda Antonín
29 79 Komenda Antonín
Experimental:
30 72 Komenda Antonín
* [[NetEmu]] _(netemu)_
31 66 Komenda Antonín
32 70 Komenda Antonín
h2. Conventions
33 1 Komenda Antonín
34 70 Komenda Antonín
h3. Feature Acceptance Process
35 2 Komenda Antonín
36 2 Komenda Antonín
* docs - javadoc, usage examples
37 1 Komenda Antonín
* tests - testing usage examples, testing complete documented functionality 
38 26 Komenda Antonín
* design compliance - loosely coupling, API centric
39 26 Komenda Antonín
40 63 Komenda Antonín
h3. Code ("Eclipse Formatter":http://jones.felk.cvut.cz/redmine/attachments/download/46/eclipse_formatter.xml)
41 26 Komenda Antonín
42 26 Komenda Antonín
* indentation: 4 spaces
43 26 Komenda Antonín
* no trailing whitespaces
44 26 Komenda Antonín
* coding style: http://java.sun.com/docs/codeconv/
45 36 Komenda Antonín
* maximum line width: 100
46 26 Komenda Antonín
* no standard Eclipse warnings and errors in cz.agents.alite package
47 84 Komenda Antonín
* no standard Eclipse errors in experimental modules (warnings are tolerated in experimental modules)
48 26 Komenda Antonín
49 27 Komenda Antonín
h3. Committing
50 26 Komenda Antonín
51 26 Komenda Antonín
* small atomic commits (logically bounded change)
52 26 Komenda Antonín
* commit whole branch
53 54 Komenda Antonín
* for larger changes in cz.agents.alite package do special branch
54 26 Komenda Antonín
* always use commit message
55 26 Komenda Antonín
* commit message has format: 
56 26 Komenda Antonín
<pre>
57 28 Komenda Antonín
One line of commit summary (fixes #XYZ)
58 26 Komenda Antonín
59 28 Komenda Antonín
Optionally explanation of the commit details.
60 1 Komenda Antonín
</pre>
61 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)
62 34 Komenda Antonín
* in case of (fixes #XYZ), the commit summary should copy the title of the issue #XYZ
63 35 Komenda Antonín
* do not commit any commented-out code
64 1 Komenda Antonín
65 4 Komenda Antonín
66 4 Komenda Antonín
h2. Version Schema
67 4 Komenda Antonín
68 45 Komenda Antonín
major.minor(.revision|-SNAPSHOT)
69 2 Komenda Antonín
70 2 Komenda Antonín
* major = complete redesign (major API changes - no backward compatibility)
71 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)
72 1 Komenda Antonín
* revision = fixes, new features (only compatible API changes - full backward compatibility)
73 45 Komenda Antonín
* SNAPSHOT = newest snapshot of major.minor version
74 4 Komenda Antonín
75 4 Komenda Antonín
76 6 Komenda Antonín
h2. Repositories
77 1 Komenda Antonín
78 41 Komenda Antonín
On Mercurial ([[Mercurial|Mercurial on Smith tutorial]]):
79 41 Komenda Antonín
* *Alite main* - ssh://USER@smith.felk.cvut.cz//data/hg/alite
80 86 Komenda Antonín
** *Trajectory Tools* - ssh://USER@smith.felk.cvut.cz//data/hg/alite/trajectorytools
81 1 Komenda Antonín
** *Configurators*
82 88 Komenda Antonín
*** *Config Reader sources* - ssh://USER@smith.felk.cvut.cz//data/hg/alite/configurator/configreader
83 1 Komenda Antonín
*** *Template Groovy Configurator sources* - ssh://USER@smith.felk.cvut.cz//data/hg/alite/configurator/templategroovy
84 86 Komenda Antonín
** *Vis 3D module sources* - ssh://USER@smith.felk.cvut.cz//data/hg/alite/vis3d
85 47 Komenda Antonín
** *KML Visio module sources* - ssh://USER@smith.felk.cvut.cz//data/hg/alite/kmlvisio
86 65 Komenda Antonín
*** *Customized JAK module sources* - ssh://USER@smith.felk.cvut.cz//data/hg/alite/kmlvisio/customjak
87 1 Komenda Antonín
** *Aglobe Adapter sources* - ssh://USER@smith.felk.cvut.cz//data/hg/alite/aglobeadapter
88 82 Komenda Antonín
89 81 Komenda Antonín
* *Alite experimental*
90 72 Komenda Antonín
** *NetEmu sources* - ssh://USER@smith.felk.cvut.cz//data/hg/alite/netemu
91 12 Jakob Michal
92 55 Komenda Antonín
* *Alite documents* - ssh://USER@smith.felk.cvut.cz//data/hg/alite/doc
93 55 Komenda Antonín
94 15 Jakob Michal
h2. Blueprints
95 14 Jakob Michal
96 13 Jakob Michal
Strategic areas of development:
97 13 Jakob Michal
* Reporting and Visualization -- post-analysis, replay, debugging support etc.
98 12 Jakob Michal
* Communication -- low-level (transport etc.) vs. high-level (protocols etc.)
99 13 Jakob Michal
* Agent Control (behavior modularization) -- activities vs. actions, agent memory etc.
100 13 Jakob Michal
* Graph/Network Environments -- representation of graph-based environments (streetnetworks etc.)