# iNaturalist Extractor - Documentation

## Quel est l'intérêt

Cet outil vous permet d'extraire les données de la base de données d'iNaturalist. Cette extraction est basée soit sur une emprise tracée par l'utilisateur sur le canvas soit sur l'emprise d'une couche d'information géographique.
Les données sont issues de l'API publiée par iNaturalist merci de prendre connaissance des [Pratiques Recommandées de l'API](https://www.inaturalist.org/pages/api+recommended+practices)avant d'utiliser le plugin.

## Comment l'utiliser

Seulement 3 étapes sont nécéssaires pour utiliser l'outil {{ title }}:

1. [Choisir une emprise pour extraire les données.](https://plugin-inaturalist-extractor-52906a.frama.io/usage/fr_how_to_use.html#choisir-une-emprise)

1. [Choisir le système de projection de la couche en sortie.](https://plugin-inaturalist-extractor-52906a.frama.io/usage/fr_how_to_use.html#choisir-une-projection)

1. [Choisir si vous souhaitez sauvegarder le résultat, et si c'est le cas sélectionner un format et un dossier d'export.](https://plugin-inaturalist-extractor-52906a.frama.io/usage/fr_how_to_use.html#choisir-un-format-de-sortie)

### Interface utilisateur

<p align="center">
  <img src="https://framagit.org/JulesGrillot/plugin_inaturalist_extractor/-/raw/main/inaturalist_extractor/resources/images/plugin_ui.png?ref_type=heads" alt="user_interface"/>
</p>

### 1. Choisir une emprise

Vous pouvez soit dessiner un rectangle sur la carte (par défaut) ou sélectionner une couche dans votre projet et utiliser son emprise.

#### Choisissez votre manière

2 cases à cocher vous permettent de sélectionner comment définir l'emprise utilisée pour l'extraction des données :

- `Tracer une emprise pour extraire les données :` si vous souhaitez tracer une emprise. Puis vous devez cliquer sur le bouton `Tracer une emprise` et dessiner un rectangle sur la carte.

- `Utiliser l'emprise d'une couche pour l'extraction :` si vous souhaitez utiliser l'emprise d'une couche. Cochez la case puis utiliser la liste déroulante pour sélectionner une couche d'information géographique à utiliser.

#### Message d'erreur

La couche sélectionnée ou l'emprise tracée couvre plus de 10 000 observations. C'est le nombre maximum d'observations pouvant être extraite en 1 fois via l'API.

<p align="center">
  <img src="https://framagit.org/JulesGrillot/plugin_inaturalist_extractor/-/raw/main/inaturalist_extractor/resources/images/too_many_obs_error.png?ref_type=heads" alt="too_many_obs_error"/>
</p>

### 2. Choisir une projection

Vous pouvez sélectionner un système de projection (par défaut celui du projet courant sera sélectionné).

### 3. Choisir un format de sortie

#### Sauvegarder le résultat dans une couche temporaire

Si vous ne voulez pas sauvegarder les données extraites (par défaut) vous avez uniquement à choisir un système de projection.

#### Sauvegarder le résultat dans une couche permanente

Si vous souhaitez sauvergarder les données extraites comme des couches permanentes, vous devez :

- sélectionner un système de projection.
- cocher la case `Sauvergarder les résultats :`.
- sélectionner si vous souhaitez ajouter les données exportées au projet (par défaut) ou non.
- sélectionner le format d'export `GeoPackage` (par défaut), `Shapefile` ou `GeoJSon`.
- sélectionner le dossier d'export pour sauvegarder la nouvelle couche permanent à l'intérieur d'un dossier intitulé  `iNaturalist_Export_yyyymmdd_HHMM`.

### Lancer l'extraction

L'extraction débute quand vous cliquez sur le bouton `OK`.

## Outils additionnels

En cliquant sur le logo d'iNaturalist , vous serez rediriger vers le site web d'iNaturalist. En cliquant sur le bouton `Documentation` vous serez redirigés vers cette page. En cliquant sur le bouton `Metadonnées`, vous serez rediriger vers la page "A propos" d'iNaturalist. Un fond de carte OpenStreetMap est automatiquement ajouté au projet si aucune couche n'est présente dans le projet. Ainsi l'utilisateur peut facilement tracer un rectangle