earth osm

Earth-Osm

Commande unique pour extraire les données d'infrastructure d'OpenStreetMap

Aperçu

Téléchargements, filtres, nettoyage et exportation des données d'infrastructure d'OpenStEetMap (OSM). Il fournit une API Python et une interface CLI pour extraire des données pour divers types d'infrastructures, tels que les lignes électriques, les sous-stations, etc.

? Caractéristiques clés

• ? Extrait les données d'infrastructure de l'OSM
• ? Nettoyez et standardise les données (à venir)
• Aucune limite de taux d'API (données desservies de Geofabrik)
• ? Fournit une API Python
• Prend en charge le multiprocessement pour une extraction plus rapide
• Sorte les données dans les formats .csv et .geojson
• ? Prend en charge l'extraction globale des données
• «Interface CLI facile à utiliser

Commencer

Installation

Installez Earth-OSM à l'aide de PIP (recommandé):

pip install earth-osm

Ou avec conda:

conda install --channel=conda-forge earth-osm

Utilisation de base

Extraire les données OSM à l'aide de la CLI:

earth_osm extract power --regions benin monaco --features substation line

Cette commande extrait les données d'infrastructure d'alimentation pour le Bénin et le Monaco, en se concentrant sur les sous-stations et les lignes électriques. Par défaut, les fichiers .csv et .geojson résultants sont stockés dans ./earth_data/out .

Chargez les données extraites à l'aide de pandas:

 import pandas as pd
import geopandas as gpd

# For Pandas
df_substations = pd . read_csv ( './earth_data/out/BJ_raw_substations.csv' )

# For GeoPandas
gdf_substations = gpd . read_file ( './earth_data/out/BJ_raw_substations.geojson' )

Référence à la CLI

Extraire la commande

earth_osm extract < primary > --regions < region 1> < region 2> ... [options]

Arguments:

• <primary> : caractéristique principale à extraire (par exemple, puissance)

Options requises:

• --regions : spécifiez une ou plusieurs régions à l'aide de codes ISO 3166-1 Alpha-2, ISO 3166-2 ou noms complets

Astuce: une liste des régions est disponible sur régions.md

Arguments facultatifs:

Argument	Description	Défaut
--features	Spécifiez les sous-fonctions de la caractéristique principale	Toutes les fonctionnalités
--update	Mettre à jour les données existantes	FAUX
--no_mp	Désactiver le multiprocessement	False (MP activé)
--data_dir	Chemin de répertoire de données	'./Earth_data'
--out_dir	Chemin vers le répertoire de sortie	Identique à DATA_DIR
--out_format	Format d'exportation (s): CSV et / ou Geojson	['CSV', 'Geojson']
--agg_feature	Les sorties agrégées par fonctionnalité	FAUX
--agg_region	Sorties agrégées par région	FAUX

? API Python

Pour une utilisation plus avancée, vous pouvez utiliser l'API Python:

 import earth_osm as eo

eo . save_osm_data (
    primary_name = 'power' ,
    region_list = [ 'benin' , 'monaco' ],
    feature_list = [ 'substation' , 'line' ],
    update = False ,
    mp = True ,
    data_dir = './earth_data' ,
    out_format = [ 'csv' , 'geojson' ],
    out_aggregate = False ,
)

Développement

Pour contribuer à la Terre-OSM, suivez ces étapes:

1. (Facultatif) Installez une version spécifique de Earth_OSM:

   pip install git+https://github.com/pypsa-meets-earth/earth-osm.git@ < required-commit-hash >

2. (Facultatif) Créez un environnement virtuel pour Python> = 3.10:

   python3 -m venv .venv
   source .venv/bin/activate

3. Installez les dépendances de développement:

   pip install git+https://github.com/pypsa-meets-earth/earth-osm.git
   pip install -e .[dev]

4. Lisez le fichier contribution.md pour des informations plus détaillées sur la façon de contribuer au projet.

? Licence

Ce projet est autorisé sous la licence du MIT. Voir le fichier de licence pour plus de détails.

? Communauté

Rejoignez notre communauté Discord pour vous connecter avec d'autres utilisateurs et contributeurs, posez des questions et obtenez un soutien.

Documentation

Pour des informations plus détaillées, consultez notre documentation complète.

---

Fabriqué avec ❤️ par la Pypsa Meets Earth Team