README.md 2.98 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

Lorys Hamadache's avatar
Lorys Hamadache committed
5 6

## Comment utiliser le projet
Romain Creuzenet's avatar
Romain Creuzenet committed
7 8 9 10 11 12 13 14 15 16
• Pour installer le projet :
	télécharcher toutes les librairies python listées dans requirements.txt

• 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

• Pour exploiter l'un des 3 objectif du projet:
	exécuter main.py. Une interface dans le terminal va vous guider

Lorys Hamadache's avatar
Lorys Hamadache committed
17
## Objectif du projets
Romain Creuzenet's avatar
Romain Creuzenet committed
18 19 20 21 22 23
• 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é.

• À un instant donné je veux pouvoir obtenir une carte me représentant n’importe quel indicateur.

• Pour une période de temps donnée, je veux pouvoir obtenir clusteriser l’espace, et représenter cette clusterisation.

Lorys Hamadache's avatar
Lorys Hamadache committed
24
## Architecture du projet 
Romain Creuzenet's avatar
Romain Creuzenet committed
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
    • 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.

    • Le fichier « requierments.txt » :
Ce fichier permet d’obtenir toutes les librairies à installer pour faire fonctionner le projet.

    • Le fichier « download_data.py » :
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.

    • Le fichier « create_table.py » :
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.

    • Le fichier « main.py » :
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.

    • Le dossier « out » :
Ce dossier stocke les graphiques issues de l’exploitation des données. Les fichiers qu’il contient peuvent être consulté plus tard, par l’utilisateur

    • Le dossier « data » :
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.