Wiki » History » Version 94

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