Mines ParisTech - PSL

UE22 - Projet d'informatique - Ecosystème Logistique

Judith Bellon, Gabrielle Vernet, César Almecija, Louis-Justin Tallot

Documentation

La documentation du projet est disponible à cette adresse :

https://louisjustintallot.github.io/UE22-projet-ecosysteme-logistique

Dépendances

Ce projet dépend des technologies et ressources suivantes :

• Langages :

  • HTML 5, CSS 3, et Javascript
  • Python
  • C++ compilé avec g++

• Formats de fichiers :

  • JSON majoritairement
  • GEOJSON également, parfois plus adapté
  • CSV pour explorer les données de manière plus convéniente avec Excel

• Logiciels :

  • Google Earth pour explorer le terrain de l'Île-de-France et faire des choix géographiques
  • QGIS pour construire les shapefiles à partir des bases de données géographiques

• Générateurs de documentation :

  • Doxygen pour les fichiers C++
  • Sphinx pour générer les pages web de la documentation ainsi que pour les fichiers python
  • Breathe pour incorporer la documentation générée par doxygen pour les fichiers C++ dans les pages créées par Sphinx

• Ressources, plugins, packages :

  • OpenStreetMap pour les fonds de carte

  • Base OpenData Île de France et notamment les bases de données suivantes :

    • Base Sirene des entreprises et de leurs établissements
    • BAN - Base Adresse Nationale - Paris
    • BAN - Base Adresse Nationale - Hauts-de-Seine
    • BAN - Base Adresse Nationale - Val-de-Marne
    • BAN - Base Adresse Nationale - Val-de-Marne
    • BAN - Base Adresse Nationale - Seine-Saint-Denis
    • Base IRIS pour les contours de l'Île-de-France

  • Base APUR, hydrographie surfacique de l'Île-de-France

  • Les plugins Javascript :

    • Leaflet pour insérer des cartes OSM dans les pages web
    • le projet Leaflet/Leaflet.markercluster pour regrouper les points et accélèrer l'affichage
    • le projet pointhi/leaflet-color-markers pour des marqueurs de couleurs variées

  • Les packages Python :

    • GeoPandas pour analyser et traiter les données géographiques
    • Folium pour générer des cartes et fichiers HTML
    • shapely pour manipuler les données géographiques sous forme de points et de polygones
    • json pour traiter des fichiers JSON
    • ijson pour traiter de manière itérative de lourds fichiers JSON
    • time pour mesurer le temps de traitement
    • matplotlib pour analyser les données issues des bases ainsi que visualiser le résultat du clustering
    • Jupyter pour développer de manière plus rapide (supporte même Folium)
    • PyQt5 pour réaliser l'interface homme-machine
    • QtWebEngine pour afficher les fichiers HTML générés par Folium dans l'interface PyQt
    • Cython pour compiler certains de nos modules et accélérer notre code

  • Les librairies C++ :

    • iostream pour les entrées/sorties
    • fstream pour lire/écrire les fichiers
    • string pour manipuler les chaînes de caractères
    • chrono pour mesurer le temps d'exécution des différentes parties du programme

Contribuer au projet

Les contributions sont bienvenues !

Pour cela, il vous faudra possèder sur votre ordinateur :

• Le système de gestion de version Git (par exemple en installant Git-Bash sur Windows)
• Un éditeur de texte comme Sublime Text ou Visual Studio Code
• Python, distribué sous Miniconda ou Anaconda (plus lourd)

Puis vous devrez clone ce répo Github : pour cela, ouvrez un shell (invite de commande) dans le dossier où vous voudrez ensuite retrouver le projet. Puis, tapez git clone https://github.com/LouisJustinTALLOT/UE22-projet-ecosysteme-logistique.git et faite Entrer. Git va télécharger le répo et son historique dans le dossier. Vous pouvez changer le nom du dossier en entrant à la place git clone https://github.com/LouisJustinTALLOT/UE22-projet-ecosysteme-logistique.git <nom de dossier choisi par vous>. Une fois cela effectué, vous êtes presque prêt à commencer à contribuer !

Il reste une dernière étape, qui est d'installer les dépendances du projet. Pour cela, dans le shell, placez-vous à la racine du dossier avec la commande cd et exécutez la commande : conda env create -f environment.yml. Conda va installer toute les dépendances du projet.

Il ne vous reste plus qu'à faire conda activate ecosysteme_logistique quand vous travaillez sur le projet !

Pour proposer vos changements, il faut que vous commitiez vos changements puis que vous les publiez en faisant git push et en suivant les instructions. (Normalement, VS Code guide l'utilisateur). Il faudra forker le répo puis push vos changements sur votre branche, et enfin ouvrir une pull request pour que nous puissions revoir vos changements et les intégrer au projet.

Signaler un bug

Si vous pensez avoir trouvé un bug ou avez une question sur le projet, ouvrez une issue Github (par exemple en cliquant ici : nouvelle issue).