reformatage pour documentation

nobohan 2021-10-21 17:36:36 +02:00
parent f0ee33677a
commit 8807c9d2de
10 changed files with 60 additions and 23 deletions

@ -1,3 +1,6 @@
## Accès à la base de données
L'accès à la base de données est souhaitable pour gérer directement les données encodées dans l'application. L'interface d'administration (voir Gestion-des-programmes.md) ne permet que la définition d'un programme mais ne permet pas de gérer (créer, modifier, supprimer) les données encodées. Les données peuvent être aussi gérées via un SIG (voir la section "Interaction QGIS-BD").
L'architecture de l'application est susceptible de varier selon les installations, mais si l'application a été installée suivant la configuration par conteneur docker, la base de données est accessible via:

@ -1,3 +1,6 @@
## Configuration du serveur SMTP
L'envoi d'email est nécessaire pour que les utilisateurs puissent s'enregistrer. Il se fait simplement en configurant les paramètres suivants dans le fichier `patches/back/default_config.toml`.
```

@ -1,3 +1,6 @@
## Editer le contenu statique
Par contenu statique, nous entendons toutes les pages dont le contenu n'est pas modifié par les utilisateurs du site, soit les éléments de la page d'acceuil (images, footer) et la page "À propos". Il s'agit aussi de la plupart des images et logos utilisés dans l'application.
Il n'y a pas encore d'interface d'édition simple pour ce contenu statique à la manière d'un CMS. La marche à suivre est la suivante:

@ -1,12 +1,15 @@
## Gestion des programmes
Dans l'interface d'administration, le troisième onglet, "Enquêtes", permet d'ajouter et de gérer les programmes d'observations de l'application. Cette accès ne permet pas de gérer les données encodées par les utilisateurs ou importées: pour cela, il faut utiliser la connexion avec QGIS ou directement via la base de données.
L'interface d'administration est accessible via l'adresse "/api/admin". L'onglet "Enquêtes" se subdivise en 5 parties qui permettent d'ajouter ou d'éditer un programme:
1) Projets
2) Zones géographiques
3a) Formulaires dynamiques
3b) Types de sites
4) Programmes
- 1) Projets
- 2) Zones géographiques
- 3a) Formulaires dynamiques
- 3b) Types de sites
- 4) Programmes
Ces onglets doivent être remplis dans cet ordre pour faire un programme car les programmes ont besoin des autres entités (projets, zones géographiques, formulaires, types de sites).

@ -1,3 +1,9 @@
# Interface d'administration
L'interface d'administration permet principalement de gérer les programmes, mais sans les données encodées. Elle est disponible sous l'url `api/admin`, soit <https://biomap.champs-libres.be/api/admin/>.
## Gestion des utilisateurs
Dans l'interface d'administration, le deuxième onglet, "Utilisateurs", permet de visualiser et de gérer les utilisateurs inscrits sur l'application Biommap.
Cette page liste tous les utilisateurs inscrits. Pour chaque utilisateur, lorsqu'on clique sur l'icône d'édition, on peut changer les caractéristiques de l'utilisateur: nom, prénom, nom d'utilisateur, email, téléphone, organisation, une image d'avatar, et 2 cases à cocher pour 1) activer ou non l'utilisateur et 2) donner les droits d'administrateur.

@ -1,3 +1,6 @@
## Modifier l'image d'un programme
Pour changer l'image médaillon d'un programme, qui apparait lorsqu'on clique sur l'entrée du menu "Programmes", il faut:
1) Servir l'image

@ -1,4 +1,6 @@
# Import / requalification de données externes
## Introduction
Pour certains programmes, il est possible d'importer des données externes à GeoNature et de pouvoir les requalifier dans l'application GeoNature-citizen. L'intérêt est que cela permet de profiter d'un encodage déjà existant et qu'une partie des propriétés peuvent être directement importés, sans qu'il soit nécessaire de les mesurer/observer. Par exemple, nous avons importé des données issues du géoportail wallon indiquant les [arbres remarquables](http://geoportail.wallonie.be/catalogue/d594f5a3-34ac-4cc2-a357-aae5d5263f35.html) dans le programme "Arbres" de Biommap. Des propriétés telles que la hauteur de l'arbre et la circonférence ont pu être importées. Nous avons également investigué l'import de données OpenStreetMap (arbres et haies).

@ -1,4 +1,7 @@
## Principe
## Interaction entre QGIS et la base de données
### Principe
Il est possible d'utiliser QGIS pour accéder directement aux données de la base de données BiomMap. Une table d'une base de données peut être ajouté à un projet QGIS en ajoutant une couche PostGIS, comme indiqué dans la figure suivante.
@ -11,7 +14,7 @@ Ensuite, toutes les tables sont affichées dans le navigateur (browser) de donn
![Liste des couches PostGIS](img/qgis-postgis.png)
## Accès
### Accès
Il existe un projet QGIS qui permet de lire les données de la base de données et qui a dû être partagé avec la documentation. Ce projet permet non seulement de visualiser et traiter les informations, mais aussi de les éditer (modification, suppression). Attention aux manipulations car QGIS agira dans ce projet directement sur la base de données de Biommap!

@ -1,8 +1,13 @@
## Introduction
Une nouvelle page "tableau de bord" a été ajoutée à https://biomap.champs-libres.be/fr/dashboard.
# Configuration de l'application et édition de contenu
## Plan de la page
## Page du tableau de bord
Une nouvelle page "tableau de bord" a été ajoutée à <https://biomap.champs-libres.be/fr/dashboard>.
### Plan de la page
1) Données de base
2) Occupation du sol
@ -11,22 +16,22 @@ Une nouvelle page "tableau de bord" a été ajoutée à https://biomap.champs-li
5) Les éléments surfaciques
6) Le suivi via BiomMap (des données externes)
## Données du tableau de bord
### Données du tableau de bord
### Données statiques
#### Données statiques
Une partie des données du tableau de bord sont statiques: elles n'ont pas pu être trouvées via des services web. Ces données statiques sont stockées dans un objet JS dans le fichier `dashboardData.ts`. Par exemple, il y a la superficie et le nombre d'habitants de la commune.
### Données issues des programmes
#### Données issues des programmes
## Sources des données
### Sources des données
### 1) Données de base
#### 1) Données de base
Les données de base telles que la superficie de la commune et le nombre d'habitants sont disponibles pour chaque commune sur la page web de STATBEL via <https://statbel.fgov.be/fr/commune/wasseiges#dashboard1> (exemple pour Wasseiges). Les chiffres pour toutes les communes de Belgique sont accessibles dans [ce fichier](https://statbel.fgov.be/sites/default/files/files/documents/bevolking/5.11%20Bevolkingsdichtheid/Pop_density_fr.xlsx) accessible dans [cette page](https://statbel.fgov.be/fr/themes/population/densite-de-la-population#figures).
### 2) Occupation du sol
#### 2) Occupation du sol
Des données d'occupation du sol aggrégées par commune sont disponibles via STATBEL sur [cette page](https://statbel.fgov.be/fr/themes/construction-logement/occupation-du-sol-selon-le-registre-cadastral#figures), en particulier [ce fichier](https://statbel.fgov.be/sites/default/files/files/documents/Bouwen%20%26%20wonen/2.6%20Bodembezetting%20volgens%20het%20Kadasterregister/Occupation%20du%20sol%20selon%20le%20registre%20Cadastral%20sup%20par%20commune.xls). Ce sont ces données qui ont été utilisées.
@ -36,6 +41,6 @@ Par ailleurs, il y a aussi des données d'occupation du sol en Wallonie:
- WALOUS: accessible [ici](http://geoportail.wallonie.be/catalogue/438fcfc5-ae66-4faa-a352-0368145fad50.html) mais uniquement en téléchargement. Cette donnée est récente (2018) et le plus proche de ce qu'on entend par occupation du sol. Elle n'est malheureusement pas disponible en services web.
- COSW 2007: accessible [ici](http://geoportail.wallonie.be/catalogue/290e1fe8-0d99-410e-967b-a02f389b931a.html). Cette donnée a été dépréciée par le produit WALOUS.
### 3) Production agricole et rendements
#### 3) Production agricole et rendements
Les données de production, surface emblavées et rendements sont accessible chaque année via [cette page](https://statbel.fgov.be/fr/themes/agriculture-peche/exploitations-agricoles-et-horticoles#figures). Les données par commune pour 2020 ont été téléchargées [ici](https://statbel.fgov.be/sites/default/files/files/documents/landbouw/8.1%20Land-%20en%20tuinbouwbedrijven/DBREF-L05-2020-TAB-B-2-FR.xlsx).

@ -1,10 +1,16 @@
# Utilisation des données encodées
## Utilisation via l'API
L'application GeoNature-citizen expose les données des programmes, des observations et des sites au travers de points d'API pour le fonctionnement de l'application.
Ces points d'accès peuvent aussi être utilisés pour avoir, sans authentification requise, un accès direct aux données.
## Détails de points d'API les plus utiles
### Détails de points d API les plus utiles
### 1) Point d'API de tous les programmes
#### 1) Point d'API de tous les programmes
- url: `api/programs`
- exemple: <https://biomap.champs-libres.be/api/programs>
@ -12,21 +18,21 @@ Ces points d'accès peuvent aussi être utilisés pour avoir, sans authentificat
Expose tous les programmes définis, mais sans les données (observations ou sites) de ces programmes. Peut-être utile pour retrouver l'id d'un programme afin de voir le détail du programme (point 2) ou ses observations ou sites (point 3).
### 2) Point d'API d'un programme
#### 2) Point d'API d'un programme
- url: `api/programs/{id}`
- exemple: <https://biomap.champs-libres.be/api/programs/1>
Expose le détail d'un programme, comme dans le point d'API précédent, sans les données (observations ou sites) de ce programme, mais avec la géométrie de la zone géographique du programme (par exemple la commune).
### 3) Point d'API des sites du programme
#### 3) Point d'API des sites du programme
- url: `api/sites/programs/{id}`
- exemple: <https://biomap.champs-libres.be/api/sites/programs/1>
Expose tous les sites encodés d'un programme. Donne un geojson valide qui peut être utilisé dans QGIS.
### 4) Point d'API du détail d'un site
#### 4) Point d'API du détail d'un site
- url: `api/sites/{id}`
- exemple: <https://biomap.champs-libres.be/api/sites/1>
@ -34,7 +40,7 @@ Expose tous les sites encodés d'un programme. Donne un geojson valide qui peut
Expose le détail d'un site. Comprend les photos (noms des fichiers uniquement) et tous les rapports de visites qui contiennent les informations rentrées par les utilisateurs dans le formulaire des visites.
## Utilisation de ces points d'API avec QGIS
### Utilisation de ces points d'API avec QGIS
Les données des sites peuvent être directement intégré dans un projet QGIS. Ajouter une couche vectorielle au projet en tant que fichier en spécifiant l'adresse du point d'API des sites d'un programme, par exemple https://biomap.champs-libres.be/api/sites/programs/1. La figure suivante montre une capture d'écran de cet ajout.