README.md 7.09 KB
Newer Older
Maxime Perrotin's avatar
Maxime Perrotin committed
1
2
3
4
5
6
7
8
9
10
11
12
13
OpenGEODE
=========

OpenGEODE is a tiny open-source SDL editor that is developed for
the purpose of providing an easy to use and free state machine editor and
Ada code generator to the TASTE toolchain from the European Space Agency,
running in combination with ESA's ASN.1 "Space Certifiable" ASN.1 compiler.

SDL is the Specification and Description Language (Z100 standard from ITU-T).

This is NOT related to the graphical Simple DirectMedia Layer libraries!

Visit http://sdl-forum.org for more information about SDL.
14
15
16
17
18
19
20
21
22
23
Visit http://www.pragmadev.com to get a full-featured commercial SDL tool and support


![alt tag](icons/opengeode-screenshot.png)


Features
--------

- Graphical editor of SDL processes and procedures.
dbarbera's avatar
dbarbera committed
24
- SDL2010 features: FOR loops in task symbols, hierarchical states
25
- Works on pure PR+CIF files (textual SDL notation) - no fancy proprietary save format
dbarbera's avatar
dbarbera committed
26
- Full supports ASN.1 data types - using ESA Space Certified compiler (www.github.com/ttsiodras/asn1scc)
Maxime Perrotin's avatar
Maxime Perrotin committed
27
- Generates Ada code
dbarbera's avatar
dbarbera committed
28
29
- Extensive syntax and semantic checks
- Automatic conversion to Statechart diagrams
30
- Save the complete or parts of the model to PNG/SVG/PDF files
dbarbera's avatar
dbarbera committed
31
32
33
34
35
- Hyperlinks (link a symbol content to any external document or web page)
- Zoom in, zoom-out
- Context-dependent text auto-completion
- Syntax highlighting
- Undo/Redo, Copy-Paste
36
- (Limited) VIM mode - You can use :wq or :%s,search,replace,g, and /search pattern
dbarbera's avatar
dbarbera committed
37
- SDL to LLVM code generation
Maxime Perrotin's avatar
Maxime Perrotin committed
38
- Python API to parse and render SDL from other Python modules
Maxime Perrotin's avatar
Maxime Perrotin committed
39
40
41
42

Installation
============

43
44
45
46
47
48
On Windows, download the binary from [here](http://download.tuxfamily.org/taste/opengeode_windows.zip)

Uzip it and run opengeode.exe. It contains everything without any other external dependencies.

Linux Pre-requisites
--------------------
Maxime Perrotin's avatar
Maxime Perrotin committed
49

Maxime Perrotin's avatar
Maxime Perrotin committed
50
There are several dependencies for OpenGEODE:
Maxime Perrotin's avatar
Maxime Perrotin committed
51

Maxime Perrotin's avatar
Maxime Perrotin committed
52
- Python 2.7 with pip
53
- Pyside (the Qt bindings for Python)
Maxime Perrotin's avatar
Maxime Perrotin committed
54
- Python ANTLR Runtime
55
- PyGraphviz
Maxime Perrotin's avatar
Maxime Perrotin committed
56
- enum34, singledispatch
57
- [ASN1SCC](https://github.com/ttsiodras/asn1scc)
Maxime Perrotin's avatar
Maxime Perrotin committed
58
59
- (optional) GNAT to build the generated Ada code
- mono
60
61
- llvmpy (tested with 0.12.7)
- LLVM (tested with 3.3)
Maxime Perrotin's avatar
Maxime Perrotin committed
62

Maxime Perrotin's avatar
Maxime Perrotin committed
63
On Debian, Ubuntu, and probably other distributions:
Maxime Perrotin's avatar
Maxime Perrotin committed
64

65
```bash
66
67
68
69
$ sudo apt-get install python-pyside pyside-tools graphviz python-pip gnat libmono-system-runtime4.0-cil \
               libmono-corlib4.0-cil libmono-system-runtime-serialization-formatters-soap4.0-cil libmono-system-web4.0-cil \
               libmono-system-xml4.0-cil libmono-system4.0-cil mono-runtime libmono-system-numerics4.0-cil \
               libmono-system-data-linq4.0-cil libmono-corlib2.0-cil libmono-system2.0-cil
Maxime Perrotin's avatar
Maxime Perrotin committed
70
71
$ sudo pip install --upgrade graphviz enum34 singledispatch
$ sudo pip install antlr_python_runtime --allow-external antlr_python_runtime --allow-unverified antlr_python_runtime
72
```
Maxime Perrotin's avatar
Maxime Perrotin committed
73

Maxime Perrotin's avatar
Maxime Perrotin committed
74
To install the ASN.1 compiler:
Maxime Perrotin's avatar
Maxime Perrotin committed
75

76
```bash
Maxime Perrotin's avatar
Maxime Perrotin committed
77
$ cd /opt
78
$ sudo wget http://download.tuxfamily.org/taste/ASN1SCC/ASN1SCC-latest.tgz
79
$ sudo tar zxvf ASN1SCC-latest.tgz
80
$ echo 'export PATH=$PATH:/opt/<path to latest ASN1SCC>/bin' >> ~/.bashrc
81
```
Maxime Perrotin's avatar
Maxime Perrotin committed
82

Maxime Perrotin's avatar
Maxime Perrotin committed
83
Check that it works:
Maxime Perrotin's avatar
Maxime Perrotin committed
84

Maxime Perrotin's avatar
Maxime Perrotin committed
85
86
87
```bash
$ asn1.exe
```
Maxime Perrotin's avatar
Maxime Perrotin committed
88

89
Optionally, to install llvmpy and LLVM follow the instructions [here](http://www.llvmpy.org/llvmpy-doc/0.12.7/doc/getting_started.html#installation)
dbarbera's avatar
dbarbera committed
90

Maxime Perrotin's avatar
Maxime Perrotin committed
91
92
OpenGEODE installation
----------------------
Maxime Perrotin's avatar
Maxime Perrotin committed
93

Maxime Perrotin's avatar
Maxime Perrotin committed
94
To install the application on your machine, once all dependencies are met:
95
96
97
98

```bash
$ pip install --upgrade opengeode
```
Maxime Perrotin's avatar
Maxime Perrotin committed
99
100
101
102
103
104
105
106

This is sufficient to get opengeode running

Installation from source
------------------------

You can get the source from the TASTE repositories or from GitHub

107
```bash
Maxime Perrotin's avatar
Maxime Perrotin committed
108
$ git clone https://github.com/maxime-esa/opengeode.git
dbarbera's avatar
dbarbera committed
109
```
Maxime Perrotin's avatar
Maxime Perrotin committed
110

111
Then enter the opengeode directory and as root, type:
Maxime Perrotin's avatar
Maxime Perrotin committed
112

113
```bash
Maxime Perrotin's avatar
Maxime Perrotin committed
114
$ make install
115
```
Maxime Perrotin's avatar
Maxime Perrotin committed
116

Maxime Perrotin's avatar
Maxime Perrotin committed
117
118
Installation is optional. You can simply run opengeode.py to get it work.

Maxime Perrotin's avatar
Maxime Perrotin committed
119
120
121
122
123
124
125
Information and contact
=======================

OpenGEODE is part of the TASTE project.

Find more information and download at http://taste.tuxfamily.org

Maxime Perrotin's avatar
Maxime Perrotin committed
126
127
128
129
TASTE allows to create embedded software systems that combine SDL models with C, Ada,
Matlab-Simulink and a few other languages or tools.

OpenGEODE is mainly designed, developed and maintained by Maxime Perrotin
Maxime Perrotin's avatar
Maxime Perrotin committed
130
131
maxime (dot) perrotin (at) esa (dot) int

Maxime Perrotin's avatar
Maxime Perrotin committed
132
133
134
135
The LLVM backend was designed and implemented by Diego Barbera during the ESA Summer of Code 2014

Some parts have been implemented by Laurent Meyer (native SDL type support in the parser)

Maxime Perrotin's avatar
Maxime Perrotin committed
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
The background pattern was downloaded from www.subtlepatterns.com

The ASN.1 compiler (ASN1Scc) that OpenGEODE is based on was
developed by George Mamais and Thanassis Tsiodras for the European
Space Agency. Information at http://www.semantix.gr/asn1scc

Licence
=======

License is LGPL (see file LICENSE)
The fonts are the fonts from Ubuntu, check licence in file FONT-LICENSE.TXT

Changelog
=========

151
152
153
1.3.5 (11/2015)
     - Better support for continous signals

Maxime Perrotin's avatar
Maxime Perrotin committed
154
155
156
157
1.3.4 (11/2015)
     - Early support for continous signals
     - Regression issue fixed (test-nocif2)

Maxime Perrotin's avatar
Maxime Perrotin committed
158
1.3.3 (11/2015)
Maxime Perrotin's avatar
Maxime Perrotin committed
159
     - Better support of platform-dependent screen resolution and dpi
Maxime Perrotin's avatar
Maxime Perrotin committed
160
     - Minor fixes in statechart scenes (no negative coordinates)
Maxime Perrotin's avatar
Maxime Perrotin committed
161

Maxime Perrotin's avatar
Maxime Perrotin committed
162
1.3.1 (11/2015)
163
     - Support for State Aggregations (parallel states)
Maxime Perrotin's avatar
Maxime Perrotin committed
164
     - Improved statechart rendering
165

166
1.2.10 (10/2015)
Maxime Perrotin's avatar
Maxime Perrotin committed
167
168
169
     - Better support of renamePolicy
     - Better handling of models without CIF coordinates
     - Minor bug fixes
170
     - Forloop syntax error handled correctly when using range
171
     - support Hex and bit string literals when working with OCTET STRING
172
     - support OUT keyword for procedure FPAR
Maxime Perrotin's avatar
Maxime Perrotin committed
173

Maxime Perrotin's avatar
Maxime Perrotin committed
174
1.2.4 (07/2015)
175
176
177
178
     - Use version 3.2.x of the ASN1SCC compiler with new -renamePolicy flag
     - Improve robustness

1.1.1 (07/2015)
Maxime Perrotin's avatar
Maxime Perrotin committed
179
180
181
     - Strongly report syntax errors with symbol location and warning if user
       tries to save a model with syntax errors

182
183
184
1.1.0 (07/2015)
     - Write/Writeln procedure support enumerated types

Maxime Perrotin's avatar
Maxime Perrotin committed
185
186
187
188
1.0.1 (06/2015)
     - Bugfix: use mono when calling asn1.exe by default (needed redhat-based
                                                          distros)

Maxime Perrotin's avatar
Maxime Perrotin committed
189
190
191
192
1.0.0 (06/2015)
     - Bugfixes and minor improvements
     - Python API / Simulator function (coupled with other TASTE components)

193
1.0RC (10/2014)
194
195
196
197
198
199
     - Release candidate Version 1
     - Allow standalone systems (made of one process)
     - Major refactoring of parser and Ada backend
     - Many bugfixes and improvements
     - First version of LLVM backend

200
201
202
0.994 (07/2014)
     - Maintenance release, minor fixes

Maxime Perrotin's avatar
Maxime Perrotin committed
203
204
205
206
207
208
209
210
211
0.993 (07/2014)
     - Parser bugfixes
     - Better support for nested states
     - Ada generator improvements
     - Support for unicode
     - Indentation of PR code
     - Copy-paste of procedures and nested states
     - Improved regression testing

212
0.99 (04/2014)
Maxime Perrotin's avatar
Maxime Perrotin committed
213
     - Refactoring of the backend engine, now using singledispatch
214
     - Support of hierachical states
Maxime Perrotin's avatar
Maxime Perrotin committed
215
216
     - Minor bugfixes

217
218

0.98
Maxime Perrotin's avatar
Maxime Perrotin committed
219
220
221
222
223
     - Added support for FOR loops
       In a task, use "for x in range([start], stop, [range]): ... endfor"
       or "for x in sequenceOfvariable: ... endfor"
     - Default symbol size is smaller
     - Various minor bugfixes
224
225
226


0.97
Maxime Perrotin's avatar
Maxime Perrotin committed
227
228
229
230
     - added support for default value when declaring a variable
       e.g. DCL myVar myType ::= { x 5, y 2 };
       default value must be a ground expression