earth osm

Earth-OSM

Satu-komandan untuk mengekstrak data infrastruktur dari OpenStreetMap

Ringkasan

Unduhan, filter, pembersihan, dan ekspor data infrastruktur dari OpenStreetMap (OSM). Ini menyediakan API Python dan antarmuka CLI untuk mengekstrak data untuk berbagai jenis infrastruktur, seperti saluran listrik, gardu induk, dan banyak lagi.

? Fitur utama

• ? Mengekstrak data infrastruktur dari OSM
• ? Membersihkan dan menstandarkan data (segera hadir)
• Tidak ada batasan tingkat API (data yang disajikan dari Geofabrik)
• ? Memberikan API Python
• Mendukung multiproses untuk ekstraksi yang lebih cepat
• Output data dalam format .csv dan .geojson
• ? Mendukung ekstraksi data global
• ? ️ Antarmuka CLI yang mudah digunakan

Memulai

Instalasi

Pasang Earth-OSM menggunakan PIP (disarankan):

pip install earth-osm

Atau dengan conda:

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

Penggunaan dasar

Ekstrak data OSM menggunakan CLI:

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

Perintah ini mengekstraksi data infrastruktur daya untuk Benin dan Monako, dengan fokus pada gardu dan saluran listrik. Secara default, file .csv dan .geojson disimpan di ./earth_data/out .

Muat data yang diekstraksi menggunakan panda:

 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' )

Referensi CLI

Ekstrak perintah

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

Argumen:

• <primary> : fitur utama untuk diekstraksi (misalnya daya)

Opsi yang Diperlukan:

• --regions : Tentukan satu atau lebih daerah menggunakan kode ISO 3166-1 Alpha-2, ISO 3166-2, atau nama lengkap

Kiat: Daftar wilayah tersedia di daerah.md

Argumen opsional:

Argumen	Keterangan	Bawaan
--features	Tentukan sub-fitur dari fitur utama	Semua fitur
--update	Perbarui data yang ada	PALSU
--no_mp	Nonaktifkan multiproses	False (MP diaktifkan)
--data_dir	Jalur ke direktori data	'./earth_data'
--out_dir	Path to Output Directory	Sama seperti data_dir
--out_format	Format Ekspor: CSV dan/atau Geojson	['csv', 'geojson']
--agg_feature	Output agregat berdasarkan fitur	PALSU
--agg_region	Output agregat berdasarkan wilayah	PALSU

? API Python

Untuk penggunaan yang lebih lanjut, Anda dapat menggunakan 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 ,
)

Perkembangan

Untuk berkontribusi pada Earth-OSM, ikuti langkah-langkah ini:

1. (Opsional) Instal versi spesifik Earth_OSM:

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

2. (Opsional) Buat lingkungan virtual untuk Python> = 3.10:

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

3. Pasang dependensi pengembangan:

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

4. Baca file contributing.md untuk informasi lebih rinci tentang cara berkontribusi pada proyek.

? Lisensi

Proyek ini dilisensikan di bawah lisensi MIT. Lihat file lisensi untuk detailnya.

? Masyarakat

Bergabunglah dengan komunitas Discord kami untuk terhubung dengan pengguna dan kontributor lain, ajukan pertanyaan, dan dapatkan dukungan.

Dokumentasi

Untuk informasi lebih rinci, lihat dokumentasi lengkap kami.

---

Dibuat dengan ❤️ oleh Pypsa Meets Earth Team