README.md 6.23 KB
Newer Older
SAPONE Alann's avatar
SAPONE Alann committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
SERVICES
DOCUMENTS
Untitled Document.md
NEW DOCUMENT
SAVE SESSION
Users finding bugs? Searching logs for errors? Find + fix broken code fast!
SAVE TO 
IMPORT FROM 
DOCUMENT NAME


Untitled Document.md
WORDS: 411
MARKDOWN Toggle Zen Mode PREVIEW


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
SAPONE Alann's avatar
SAPONE Alann committed
110 111
ETC-42
===========================
SAPONE Alann's avatar
SAPONE Alann committed
112
_______________
SAPONE Alann's avatar
SAPONE Alann committed
113 114 115
Introduction
------------
The ETC-42 is a generic exposure time calculator.
SAPONE Alann's avatar
SAPONE Alann committed
116 117 118
It has initialy been written at LAM (Laboratoire 
d'astrophysique de Marseille).
_______________
SAPONE Alann's avatar
SAPONE Alann committed
119 120 121 122 123 124 125
Dependencies
------------
- Maven
- dvipng
- Latex full
- JRE 1.7+
- JDK 1.7+ (Open JDK isn't supported)
SAPONE Alann's avatar
SAPONE Alann committed
126
_______________
SAPONE Alann's avatar
SAPONE Alann committed
127 128
How to build
------------
SAPONE Alann's avatar
SAPONE Alann committed
129 130
To build, you need you use *Maven* as following in 
project root folder:
SAPONE Alann's avatar
SAPONE Alann committed
131 132 133
```
mvn package
```
SAPONE Alann's avatar
SAPONE Alann committed
134
_______________
SAPONE Alann's avatar
SAPONE Alann committed
135 136 137
Modules Description
-------------------
ETC-DataModel:
SAPONE Alann's avatar
SAPONE Alann committed
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
- This module defines the data structures which the 
different ETC modules use to communicate.
ETC-Persistence:
- This module provides the persistency level of the ETC 
application. The current implementation is using an 
embedded database to persist the ETC data.
ETC-Calculator:
- This module is responsible for performing SNR 
calculations.
ETC-UI:
- This module is resposible for the communication with 
the user (User Interface).
There are currently two implementations, a graphical 
interface build with Swing and a terminal mode 
interface.
ETC-DataImportExport:
- This module provides functionality for importing and 
exporting data from files or VO enabled applications.
ETC-Controller:
- This module works as a conector of all the above 
projects and implements the possible schenarios of 
usage of the program.
ETC-Jar:
- This module creates a single executable jar 
containing all the necessary files to be used for easy 
ETC distribution.
ETC-WebStart:
- This module creates a Web Start version of the ETC.
ETC-Documentation:
- This module creates the latex documentation of the 
ETC.
_______________
Where to get generated outputs ?
-----------------------------
The files to use for distribution (output of the build) 
are:
```
  - ETC-Jar/target/ETC-Jar-<version>.jar
    A stand alone executable jar
```
```
  - ETC-WebStart/target/ETC-WebStart-<version>.zip
    A zip file containing the web start version of ETC
```
```
  - ETC-Documentation/target
    In this directory are the pdf versions of the Latex 
documentation
```
_______________
Build the javadoc
-----------------
The ETC javadoc uses Latexlet to create scientific 
equations. For this reason
the following requirements must be met before building 
it:
  - dvipng installed and in the path
To create the javadoc execute the following command in 
the ETC directory:
```
mvn javadoc:javadoc
```
This will build the javadoc of each project separately 
and will put the files
in the directories <project>/target/site/apidocs
_______________
Common Problems and Solutions
-----------------------------
Here are listed some common problems during the ETC 
compilation and how to
solve them.
"invalid target release: 1.x" error:
If when building the ETC this error appears, most 
probably the JAVA_HOME library
is not set correctly. This is a common problem on Mac 
OS. The solution is to
set the JAVA_HOME variable to the correct directory. 
The java home directory
differs from system to system and it depends on the 
configuration, but the
common place for it (for Mac OS) is:
/Library/Java/Home 
ETC-42
Introduction
The ETC-42 is a generic exposure time calculator.
It has initialy been written at LAM (Laboratoire d’astrophysique de Marseille).

Dependencies
Maven
dvipng
Latex full
JRE 1.7+
JDK 1.7+ (Open JDK isn’t supported)
How to build
To build, you need you use Maven as following in project root folder:

mvn package
Modules Description
ETC-DataModel:
SAPONE Alann's avatar
SAPONE Alann committed
237

SAPONE Alann's avatar
SAPONE Alann committed
238
This module defines the data structures which the different ETC modules use to communicate.
SAPONE Alann's avatar
SAPONE Alann committed
239 240
ETC-Persistence:

SAPONE Alann's avatar
SAPONE Alann committed
241
This module provides the persistency level of the ETC application. The current implementation is using an embedded database to persist the ETC data.
SAPONE Alann's avatar
SAPONE Alann committed
242 243
ETC-Calculator:

SAPONE Alann's avatar
SAPONE Alann committed
244
This module is responsible for performing SNR calculations.
SAPONE Alann's avatar
SAPONE Alann committed
245 246
ETC-UI:

SAPONE Alann's avatar
SAPONE Alann committed
247 248
This module is resposible for the communication with the user (User Interface).
There are currently two implementations, a graphical interface build with Swing and a terminal mode interface.
SAPONE Alann's avatar
SAPONE Alann committed
249 250
ETC-DataImportExport:

SAPONE Alann's avatar
SAPONE Alann committed
251
This module provides functionality for importing and exporting data from files or VO enabled applications.
SAPONE Alann's avatar
SAPONE Alann committed
252 253
ETC-Controller:

SAPONE Alann's avatar
SAPONE Alann committed
254
This module works as a conector of all the above projects and implements the possible schenarios of usage of the program.
SAPONE Alann's avatar
SAPONE Alann committed
255 256
ETC-Jar:

SAPONE Alann's avatar
SAPONE Alann committed
257
This module creates a single executable jar containing all the necessary files to be used for easy ETC distribution.
SAPONE Alann's avatar
SAPONE Alann committed
258 259
ETC-WebStart:

SAPONE Alann's avatar
SAPONE Alann committed
260
This module creates a Web Start version of the ETC.
SAPONE Alann's avatar
SAPONE Alann committed
261 262
ETC-Documentation:

SAPONE Alann's avatar
SAPONE Alann committed
263
This module creates the latex documentation of the ETC.
SAPONE Alann's avatar
SAPONE Alann committed
264 265
Where to get generated outputs ?
The files to use for distribution (output of the build) are:
SAPONE Alann's avatar
SAPONE Alann committed
266

SAPONE Alann's avatar
SAPONE Alann committed
267 268 269 270 271 272 273 274 275
  - ETC-Jar/target/ETC-Jar-<version>.jar
    A stand alone executable jar
  - ETC-WebStart/target/ETC-WebStart-<version>.zip
    A zip file containing the web start version of ETC
  - ETC-Documentation/target
    In this directory are the pdf versions of the Latex documentation
Build the javadoc
The ETC javadoc uses Latexlet to create scientific equations. For this reason
the following requirements must be met before building it:
SAPONE Alann's avatar
SAPONE Alann committed
276 277

dvipng installed and in the path
SAPONE Alann's avatar
SAPONE Alann committed
278 279 280 281 282 283 284 285 286
To create the javadoc execute the following command in the ETC directory:
mvn javadoc:javadoc
This will build the javadoc of each project separately and will put the files
in the directories <project>/target/site/apidocs

Common Problems and Solutions
Here are listed some common problems during the ETC compilation and how to
solve them.

SAPONE Alann's avatar
SAPONE Alann committed
287
“invalid target release: 1.x” error:
SAPONE Alann's avatar
SAPONE Alann committed
288 289 290 291 292
If when building the ETC this error appears, most probably the JAVA_HOME library
is not set correctly. This is a common problem on Mac OS. The solution is to
set the JAVA_HOME variable to the correct directory. The java home directory
differs from system to system and it depends on the configuration, but the
common place for it (for Mac OS) is:
SAPONE Alann's avatar
SAPONE Alann committed
293
/Library/Java/Home