README.md 3.12 KB
Newer Older
Lorys Hamadache's avatar
Lorys Hamadache committed
1
# Projet NF26 - P19 - UTC
Lorys Hamadache's avatar
Lorys Hamadache committed
2

Lorys Hamadache's avatar
Lorys Hamadache committed
3
Authors : Lorys Hamadache et Romain Creuzenet
Romain Creuzenet's avatar
Romain Creuzenet committed
4

5 6 7 8
## Organisation générale du projet
- livrables : contient le rapport PDF et le Diapo PDF
- scripts : contient le code python concernant le projet

Lorys Hamadache's avatar
Lorys Hamadache committed
9
## Comment utiliser le projet
10
- Pour installer le projet :
Romain Creuzenet's avatar
Romain Creuzenet committed
11 12
	télécharcher toutes les librairies python listées dans requirements.txt

13 14 15
- Pour initialiser les données (la première fois quand les tables sont vides):
  1. Executer download_data.py qui va télécharger tous les fichiers CSV nécessaires
  2. Executer create_table.py qui va créer et remplir les tables avec le contenu des fichiers CSV téléchargés
Romain Creuzenet's avatar
Romain Creuzenet committed
16

17
- Pour exploiter l'un des 3 objectif du projet:
Romain Creuzenet's avatar
Romain Creuzenet committed
18 19
	exécuter main.py. Une interface dans le terminal va vous guider

Lorys Hamadache's avatar
Lorys Hamadache committed
20
## Objectifs du projets
21
- Pour un point donné de l’espace, je veux pouvoir avoir un historique du passé, avec des courbes adaptés. Je vous pouvoir mettre en évidence la saisonnalité et les écarts à la saisonnalité.
Romain Creuzenet's avatar
Romain Creuzenet committed
22

23
- À un instant donné je veux pouvoir obtenir une carte me représentant n’importe quel indicateur.
Romain Creuzenet's avatar
Romain Creuzenet committed
24

25
- Pour une période de temps donnée, je veux pouvoir obtenir clusteriser l’espace, et représenter cette clusterisation.
Romain Creuzenet's avatar
Romain Creuzenet committed
26

27 28
## Architecture précise du projet
- Le fichier « requierments.txt » :
Romain Creuzenet's avatar
Romain Creuzenet committed
29
Ce fichier permet d’obtenir toutes les librairies à installer pour faire fonctionner le projet.
30 31 32 33
- livrables : contient le rapport PDF et le Diapo PDF
- scripts : contient le code python concernant le projet
  - Le fichier « parameters.py » :
	Il permet de stoker la configuration du projet (pays concerné, période de temps étudiée…). Il possède également les informations utiles à tout le projet.
Romain Creuzenet's avatar
Romain Creuzenet committed
34

35
  - Le fichier « download_data.py » :
Romain Creuzenet's avatar
Romain Creuzenet committed
36 37
Ce fichier permet de télécharger les données du pays concerné sur la période temps étudiée depuis le site internet où elles sont stockées. Ces informations seront ensuite placées dans des fichiers « csv » par station dans le dossier « out ». Le code est inspiré de celui trouvé sur le site internet gardant les données. Ce fichier n’est utilisé que très rarement, à une initialisation. Il suffit de l’exécuter pour appeler les bonnes fonctions.

38
  - Le fichier « create_table.py » :
Romain Creuzenet's avatar
Romain Creuzenet committed
39 40
Ce fichier crée les différentes tables utilisées durant le projet et les remplie des informations contenues dans tous les fichiers « csv » du dossier « out ». Ce fichier n’est utilisé que très rarement, à une initialisation. Il suffit de l’exécuter pour appeler les bonnes fonctions.

41
  - Le fichier « main.py » :
Romain Creuzenet's avatar
Romain Creuzenet committed
42 43
Ce fichier gère l’exploitation des données. Il est utilisé fréquemment. Son exécution permet d’obtenir une interface dans le terminal pour choisir son objectif, les éléments nécessaires et obtenir les résultats.

44
- Le dossier « data » :
Romain Creuzenet's avatar
Romain Creuzenet committed
45
Ce dossier contient tous les fichiers « csv » contenant toutes les informations, sur les différentes stations, qui devront être mises dans Cassandra. Ce dossier n’est pas censé être exploité manuellement par l’utilisateur.
46 47 48

- Le dossier « imgs » :
Ce dossier contient toutes les images utilisées pour les rapports