Wiki » History » Version 91

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