Commit d1771550d34378b4d251286977784224831b2b14
1 parent
f39d90e606
Exists in
master
and in
1 other branch
add README.MD
Showing 3 changed files with 34 additions and 0 deletions Side-by-side Diff
README.md
View file @
d177155
1 | +##Intro | |
2 | + | |
3 | +Maritime Visualisation is a tool that allow you to visualize ais data. | |
4 | + | |
5 | +## Usage | |
6 | +You can import data by clicking on File -> Import, and select your CSV file. The CSV file must be in this format : <br/> | |
7 | +MMSI,BaseDateTime,LAT,LON,SOG,COG,Heading,VesselName,IMO,CallSign,VesselType,Status,Length,Width,Draft,Cargo<br/> | |
8 | +![Smaller icon](src/main/resources/readmeImage/import.png?raw=true 'Import example')<br/> | |
9 | +A specific MMSI can be highlighted by selecting it in the left panel and specific data can be plot in the bottom panel.<br/> | |
10 | +![Smaller icon](src/main/resources/readmeImage/selectedData.png?raw=true 'Selected data example')<br/> | |
11 | + | |
12 | +## Requirements | |
13 | + | |
14 | +* Java installed (Jdk8). | |
15 | +* Gradle (6.2+) | |
16 | + | |
17 | + | |
18 | +## Importing and running project | |
19 | + | |
20 | +Clone the project with : | |
21 | +``` | |
22 | +git clone https://disc.univ-fcomte.fr/gitlab/fditeam/visualisation-maritime.git | |
23 | +``` | |
24 | + | |
25 | +Go to : | |
26 | +``` | |
27 | +cd visualisation-maritime | |
28 | +``` | |
29 | + | |
30 | +Build and run the project with : | |
31 | +``` | |
32 | +gradle run | |
33 | +``` | |
34 | + |
src/main/resources/readmeImage/import.png
View file @
d177155
3.85 KB
src/main/resources/readmeImage/selectedData.png
View file @
d177155
214 KB