geoai-py 0.4.1__tar.gz → 0.4.2__tar.gz

{geoai_py-0.4.1 → geoai_py-0.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: geoai-py
-Version: 0.4.1
+Version: 0.4.2
 Summary: A Python package for using Artificial Intelligence (AI) with geospatial data
 Author-email: Qiusheng Wu <giswqs@gmail.com>
 License: MIT License
@@ -34,10 +34,12 @@ Requires-Dist: scikit-image
 Requires-Dist: scikit-learn
 Requires-Dist: torch
 Requires-Dist: torchgeo
+Requires-Dist: torchinfo
 Requires-Dist: tqdm
 Requires-Dist: transformers
 Provides-Extra: extra
 Requires-Dist: overturemaps; extra == "extra"
+Dynamic: license-file
 
 # GeoAI: Artificial Intelligence for Geospatial Data
 
@@ -49,6 +51,8 @@ Requires-Dist: overturemaps; extra == "extra"
 [![image](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![image](https://img.shields.io/badge/YouTube-Tutorials-red)](https://bit.ly/GeoAI-Tutorials)
 
+[![logo](https://raw.githubusercontent.com/opengeos/geoai/master/docs/assets/logo_rect.png)](https://github.com/opengeos/geoai/blob/master/docs/assets/logo.png)
+
 **A powerful Python package for integrating Artificial Intelligence with geospatial data analysis and visualization**
 
 GeoAI bridges the gap between AI and geospatial analysis, providing tools for processing, analyzing, and visualizing geospatial data using advanced machine learning techniques. Whether you're working with satellite imagery, LiDAR point clouds, or vector data, GeoAI offers intuitive interfaces to apply cutting-edge AI models.
@@ -139,7 +143,3 @@ We welcome contributions of all kinds! See our [contributing guide](https://geoa
 ## 📄 License
 
 GeoAI is free and open source software, licensed under the MIT License.
-
-## 💖 Acknowledgment
-
-Some of the pre-trained models used in the geoai package are adapted from the [ArcGIS Living Atlas](https://livingatlas.arcgis.com/en/browse/?q=dlpk#d=2&q=dlpk). Credits to Esri for making these models available.

{geoai_py-0.4.1 → geoai_py-0.4.2}/README.md

@@ -8,6 +8,8 @@
 [![image](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![image](https://img.shields.io/badge/YouTube-Tutorials-red)](https://bit.ly/GeoAI-Tutorials)
 
+[![logo](https://raw.githubusercontent.com/opengeos/geoai/master/docs/assets/logo_rect.png)](https://github.com/opengeos/geoai/blob/master/docs/assets/logo.png)
+
 **A powerful Python package for integrating Artificial Intelligence with geospatial data analysis and visualization**
 
 GeoAI bridges the gap between AI and geospatial analysis, providing tools for processing, analyzing, and visualizing geospatial data using advanced machine learning techniques. Whether you're working with satellite imagery, LiDAR point clouds, or vector data, GeoAI offers intuitive interfaces to apply cutting-edge AI models.
@@ -98,7 +100,3 @@ We welcome contributions of all kinds! See our [contributing guide](https://geoa
 ## 📄 License
 
 GeoAI is free and open source software, licensed under the MIT License.
-
-## 💖 Acknowledgment
-
-Some of the pre-trained models used in the geoai package are adapted from the [ArcGIS Living Atlas](https://livingatlas.arcgis.com/en/browse/?q=dlpk#d=2&q=dlpk). Credits to Esri for making these models available.

{geoai_py-0.4.1 → geoai_py-0.4.2}/docs/examples/building_footprints_usa.ipynb

@@ -78,9 +78,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Initialize building footprint extraction pretrained model\n",
-    "\n",
-    "The pretained model is adapted from the Esri [building footprint extraction](https://www.arcgis.com/home/item.html?id=a6857359a1cd44839781a4f113cd5934) model for the USA. Credits to Esri for the model."
+    "## Initialize building footprint extraction pretrained model"
    ]
   },
   {

{geoai_py-0.4.1 → geoai_py-0.4.2}/docs/examples/dataviz/lidar_viz.ipynb

@@ -69,7 +69,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "url = \"https://open.gishub.org/data/lidar/madison.zip\"\n",
+    "url = \"https://opengeos.org/data/lidar/madison.zip\"\n",
     "filename = \"madison.las\""
    ]
   },

{geoai_py-0.4.1 → geoai_py-0.4.2}/docs/examples/dataviz/raster_viz.ipynb

@@ -144,7 +144,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "dem_url = \"https://open.gishub.org/data/raster/srtm90.tif\"\n",
+    "dem_url = \"https://opengeos.org/data/raster/srtm90.tif\"\n",
     "leafmap.download_file(dem_url, unzip=False)"
    ]
   },
@@ -183,7 +183,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "landsat_url = \"https://open.gishub.org/data/raster/cog.tif\"\n",
+    "landsat_url = \"https://opengeos.org/data/raster/cog.tif\"\n",
     "leafmap.download_file(landsat_url)"
    ]
   },

{geoai_py-0.4.1 → geoai_py-0.4.2}/docs/examples/dataviz/vector_viz.ipynb

@@ -62,7 +62,7 @@
    "outputs": [],
    "source": [
     "m = leafmap.Map(center=[0, 0], zoom=2)\n",
-    "data = \"https://open.gishub.org/data/vector/cables.geojson\"\n",
+    "data = \"https://opengeos.org/data/vector/cables.geojson\"\n",
     "m.add_vector(data, layer_name=\"Cable lines\", info_mode=\"on_hover\")\n",
     "m"
    ]
@@ -92,7 +92,7 @@
    "source": [
     "m = leafmap.Map(center=[20, 0], zoom=2)\n",
     "m.add_basemap(\"CartoDB.DarkMatter\")\n",
-    "data = \"https://open.gishub.org/data/vector/cables.geojson\"\n",
+    "data = \"https://opengeos.org/data/vector/cables.geojson\"\n",
     "callback = lambda feat: {\"color\": feat[\"properties\"][\"color\"], \"weight\": 1}\n",
     "m.add_vector(data, layer_name=\"Cable lines\", style_callback=callback)\n",
     "m"
@@ -182,7 +182,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "url = \"https://open.gishub.org/data/duckdb/cities.parquet\"\n",
+    "url = \"https://opengeos.org/data/duckdb/cities.parquet\"\n",
     "gdf = leafmap.read_parquet(url, return_type=\"gdf\", src_crs=\"EPSG:4326\")\n",
     "gdf.head()"
    ]

geoai_py-0.4.2/docs/examples/download_sentinel2.ipynb

@@ -0,0 +1,182 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Download Sentinel-2 Data from Planetary Computer\n",
+    "\n",
+    "[![image](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/opengeos/geoai/blob/main/docs/examples/download_sentinel2.ipynb)\n",
+    "\n",
+    "The notebook demonstrates how to download Sentinel-2 data from the [Planetary Computer](https://planetarycomputer.microsoft.com/explore) using the `geoai` package.\n",
+    "\n",
+    "## Install package\n",
+    "To use the `geoai-py` package, ensure it is installed in your environment. Uncomment the command below if needed."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# %pip install geoai-py"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Import libraries"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import geoai"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Search data\n",
+    "\n",
+    "Go to the [Planetary Computer](https://planetarycomputer.microsoft.com/explore) and search for the data you are interested in. Copy the STAC item link and paste it to the code below."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Example for Sentinel-2 item\n",
+    "item_url = \"https://planetarycomputer.microsoft.com/api/stac/v1/collections/sentinel-2-l2a/items/S2B_MSIL2A_20250228T173149_R055_T14SLH_20250228T212633\""
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Download sample data"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Specify which bands to download (Sentinel-2 bands)\n",
+    "bands_to_download = [\n",
+    "    \"B01\",\n",
+    "    \"B02\",\n",
+    "    \"B03\",\n",
+    "    \"B04\",\n",
+    "    \"B05\",\n",
+    "    \"B06\",\n",
+    "    \"B07\",\n",
+    "    \"B08\",\n",
+    "    \"B8A\",\n",
+    "    \"B09\",\n",
+    "    \"B11\",\n",
+    "    \"B12\",\n",
+    "    \"AOT\",\n",
+    "    \"WVP\",\n",
+    "    \"SCL\",\n",
+    "]"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Create a directory for the downloaded bands\n",
+    "output_directory = \"sentinel2_bands\""
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Download the bands, save them to the output directory, and create a merged GeoTIFF.\n",
+    "# The download process may take a while. Please be patient.\n",
+    "downloaded_bands = geoai.download_pc_stac_item(\n",
+    "    item_url=item_url,\n",
+    "    bands=bands_to_download,\n",
+    "    output_dir=output_directory,\n",
+    "    show_progress=True,\n",
+    "    merge_bands=True,\n",
+    "    merged_filename=\"sentinel2_all_bands.tif\",\n",
+    "    overwrite=False,  # Skip files that already exist\n",
+    "    cell_size=10,  # Resample all bands to 10m resolution\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Print the paths to the downloaded files\n",
+    "for band, path in downloaded_bands.items():\n",
+    "    print(f\"Downloaded {band}: {path}\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Visualize data"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "raster_url = \"https://huggingface.co/datasets/giswqs/geospatial/resolve/main/sentinel2a_kansas.tif\""
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "geoai.view_raster(raster_url, bidx=[8, 4, 3], rescale=\"1000,4000\")"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "geo",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.12.9"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

geoai_py-0.4.2/docs/examples/planetary_computer.ipynb

@@ -0,0 +1,120 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Download Data from Planetary Computer\n",
+    "\n",
+    "[![image](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/opengeos/geoai/blob/main/docs/examples/planetary_computer.ipynb)\n",
+    "\n",
+    "## Install package\n",
+    "To use the `geoai-py` package, ensure it is installed in your environment. Uncomment the command below if needed."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# %pip install geoai-py"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Import libraries"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import geoai"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Retrieve collections"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "collections = geoai.pc_collection_list()\n",
+    "collections"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Search data"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "items = geoai.pc_stac_search(\n",
+    "    collection=\"naip\",\n",
+    "    bbox=[-122.5, 47.2, -122.3, 47.4],  # Seattle area\n",
+    "    time_range=\"2023-01-01/2024-12-31\",\n",
+    "    max_items=1,\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Download data"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "if items:\n",
+    "    # Only download the visual imagery and thumbnail assets\n",
+    "    downloaded = geoai.pc_stac_download(\n",
+    "        items, output_dir=\"naip_data\", asset_keys=[\"image\", \"thumbnail\"], max_workers=3\n",
+    "    )"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "geo",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.12.9"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

geoai_py-0.4.2/docs/examples/train_building_footprints_usa.ipynb

@@ -0,0 +1,259 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Train a Building Footprints Detection Model for the USA\n",
+    "\n",
+    "[![image](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/opengeos/geoai/blob/main/docs/examples/train_building_footprints_usa.ipynb)\n",
+    "\n",
+    "## Install package\n",
+    "To use the `geoai-py` package, ensure it is installed in your environment. Uncomment the command below if needed."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# %pip install geoai-py"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Import libraries"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import geoai"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Download sample data"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "train_raster_url = (\n",
+    "    \"https://huggingface.co/datasets/giswqs/geospatial/resolve/main/naip_rgb_train.tif\"\n",
+    ")\n",
+    "train_vector_url = \"https://huggingface.co/datasets/giswqs/geospatial/resolve/main/naip_train_buildings.geojson\"\n",
+    "test_raster_url = (\n",
+    "    \"https://huggingface.co/datasets/giswqs/geospatial/resolve/main/naip_test.tif\"\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "train_raster_path = geoai.download_file(train_raster_url)\n",
+    "train_vector_path = geoai.download_file(train_vector_url)\n",
+    "test_raster_path = geoai.download_file(test_raster_url)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Visualize sample data"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "geoai.view_vector_interactive(train_vector_path, tiles=train_raster_url)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "geoai.view_raster(test_raster_url)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Create training data"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "out_folder = \"output\"\n",
+    "tiles = geoai.export_geotiff_tiles(\n",
+    "    in_raster=train_raster_path,\n",
+    "    out_folder=out_folder,\n",
+    "    in_class_data=train_vector_path,\n",
+    "    tile_size=512,\n",
+    "    stride=256,\n",
+    "    buffer_radius=0,\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Train object detection model"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "geoai.train_MaskRCNN_model(\n",
+    "    images_dir=f\"{out_folder}/images\",\n",
+    "    labels_dir=f\"{out_folder}/labels\",\n",
+    "    output_dir=f\"{out_folder}/models\",\n",
+    "    num_channels=3,\n",
+    "    pretrained=True,\n",
+    "    batch_size=4,\n",
+    "    num_epochs=100,\n",
+    "    learning_rate=0.005,\n",
+    "    val_split=0.2,\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Run inference"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "masks_path = \"naip_test_prediction.tif\"\n",
+    "model_path = f\"{out_folder}/models/building_footprints_usa.pth\""
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "geoai.object_detection(\n",
+    "    test_raster_path,\n",
+    "    masks_path,\n",
+    "    model_path,\n",
+    "    window_size=512,\n",
+    "    overlap=256,\n",
+    "    confidence_threshold=0.5,\n",
+    "    batch_size=4,\n",
+    "    num_channels=3,\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Vectorize masks"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "output_path = \"naip_test_prediction.geojson\"\n",
+    "gdf = geoai.orthogonalize(masks_path, output_path, epsilon=2)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Visualize results"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "geoai.view_vector_interactive(output_path, tiles=test_raster_url)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "geoai.create_split_map(\n",
+    "    left_layer=output_path,\n",
+    "    right_layer=test_raster_url,\n",
+    "    left_args={\"style\": {\"color\": \"red\", \"fillOpacity\": 0.2}},\n",
+    "    basemap=test_raster_url,\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "![image](https://github.com/user-attachments/assets/8dfcc69e-7a6c-408a-9fae-10b81b7d85dc)"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.12.9"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}