README.adoc 2.73 KB
Newer Older
BERGER's avatar
BERGER committed
1
2
3
4
# Welcome to the MOVIES3D Python code repository

MOVIES3D is a software designed by [Ifremer](https://wwz.ifremer.fr/en) to [display and process underwater active acoustic data](http://flotte.ifremer.fr/content/download/6032/129677/file/MOVIES3D_general.pdf) produced by [sonars](https://en.wikipedia.org/wiki/Sonar) and [echosounders](https://en.wikipedia.org/wiki/Echo_sounding).

DORAY's avatar
DORAY committed
5
This repository has been set up to share codes making use of MOVIES3D APIs with the Python programming language.
BERGER's avatar
BERGER committed
6

PONCELET's avatar
PONCELET committed
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

== Project Organization

Project organization is inspired by
https://drivendata.github.io/cookiecutter-data-science/#cookiecutter-data-science

----
├── LICENSE
├── README.md          <- The top-level README for developers using this project.
├── data
│   ├── external       <- Data from third party sources.
│   ├── interim        <- Intermediate data that has been transformed.
│   ├── processed      <- The final, canonical data sets for modeling.
│   └── raw            <- The original, immutable data dump.

├── docs               <- A default Sphinx project; see sphinx-doc.org for details

├── notebooks          <- Jupyter notebooks. Naming convention is a number (for ordering),
│                         the creator's initials, and a short `-` delimited description, e.g.
│                         `1.0-jqp-initial-data-exploration`.

├── references         <- Data dictionaries, manuals, reference articles and all other explanatory materials.

├── reports            <- Generated analysis as HTML, PDF, LaTeX, etc.
│   └── figures        <- Generated graphics and figures to be used in reporting

├── setup.py           <- makes project pip installable (pip install -e .) so src can be imported

├── pymovies_3d        <- Source code for use in this project.
│   ├── __init__.py    <- Makes src a Python module
BERGER's avatar
BERGER committed
37
38
│   │
│   │
PONCELET's avatar
PONCELET committed
39
│   ├── core   <- project main modules and algorithm, should not depends on any graphical (eg QT)
BERGER's avatar
BERGER committed
40
41
│   │               or visualization library (eg matplotlib)
│   │
BERGER's avatar
BERGER committed
42
│   ├── studies   <- studies and associated code that are linked to a specific dataset
BERGER's avatar
BERGER committed
43
│   |
PONCELET's avatar
PONCELET committed
44
│   ├── test    <- Unit test
BERGER's avatar
BERGER committed
45
│   │
PONCELET's avatar
PONCELET committed
46
47
48
49
50
51
52
│   └── visualization  <- Scripts to create exploratory and results oriented visualizations and graphical api
|
├── requirements   <- The requirements files for reproducing the analysis environment,
|                     use create_anaconda_environment.py script to create them


----
BERGER's avatar
BERGER committed
53
Please proceed to [the wiki](https://gitlab.ifremer.fr/fleet/movies/movies_script/-/wikis/home) for more information on how to get and use MOVIES3D and its APIs.
PONCELET's avatar
PONCELET committed
54