Add some doc

This commit is contained in:
Félix Baylac-Jacqué 2022-02-21 12:48:35 +01:00
parent 77f9be057e
commit 17849388cc
2 changed files with 23 additions and 0 deletions

8
README.md Normal file
View file

@ -0,0 +1,8 @@
# Visionneur d'IPEs
Axione nous fournit ses données d'éligibilité brutes sous la forme de fichiers CSV nommés IPE.
Ce dépôt est divisé en deux parties:
- `/webapp`: application web (Python Flask/Leaflet) qui affiche les données d'éligibilité d'Axione sur une carte interactive.
- `/data-ingest`: scripts bash/SQLite en charge de transformer les données en une base de données exploitable par l'application web depuis les CSV fournit par Axione.

15
data-ingest/README.md Normal file
View file

@ -0,0 +1,15 @@
# Transformation de Données
Vous pouvez trouver dans ce dossier tous les scripts que nous utilisons pour récupérer et transformer les fichiers CSV IPE fournis par Axione en une base de données SQLite/Spatialite exploitable par l'application web.
## ./ingest
Ce script va aggréger les fichiers CSV IPE contenus dans un dossier en une seule geo-db SQLite exploitable par l'application web.
```
Usage: ingest path-to-directory-containing-IPE-CSVs path-to-generated-db
```
Dépendances: `sqlite3`, `libspatialite`. Note: si vous avez nix, le `nix-shell` du projet injectera ces dépendances & le `LD_LIBRARY_PATH` adéquat pour vous.
Les données géographiques localisant les immeubles fournies par Axione sont référencées à l'aide du [réseau geodésique Français (RGF93)](https://fr.wikipedia.org/wiki/R%C3%A9seau_g%C3%A9od%C3%A9sique_fran%C3%A7ais). Openstreetmap étant basé sur le ["World Geodetic System 1984 (WSG84)"](https://fr.wikipedia.org/wiki/WGS_84), Il nous faut convertir ces coordonées avant de pouvoir les exploiter. Nous utilisons l'extension SQLite Spatialite pour ça.