Skip to main content

A CLI tool for processing LiDAR data from Nova Scotia and PEI using QGIS

Project description

QGIS Nova Scotia & PEI LiDAR Processing Tool

A command-line tool for processing LiDAR data from Nova Scotia and Prince Edward Island using QGIS. This tool allows you to:

  • Geocode addresses in Nova Scotia and PEI
  • Download and process LiDAR point cloud data
  • Extract building footprints from LiDAR data
  • Generate satellite imagery for the location
  • Visualize 3D point clouds

Features

  • Address geocoding using OpenStreetMap Nominatim API
  • Coordinate transformation between different CRS (WGS84, NAD83(CSRS), MTM zone 5)
  • LiDAR point cloud processing using laspy
  • Building point extraction
  • 3D visualization capabilities
  • Satellite imagery retrieval from Mapbox

Prerequisites

  • Python 3.8 or higher
  • QGIS 3.22.0 or higher
  • Conda (required for QGIS installation)

Installation

The installation process has two steps: setting up QGIS and installing this package.

1. Install QGIS using Conda

First, create a new conda environment with QGIS installed:

# Create a new environment with QGIS and Python 3.8
conda create -n qgis-env -c conda-forge qgis python=3.8

# Activate the environment
conda activate qgis-env

2. Install qgis-ns-pe

After activating the conda environment, install this package:

# For users: install from PyPI
pip install qgis-ns-pe

# For developers: install in editable mode from source
git clone https://github.com/amadgakkhar/qgis-ns-pe.git
cd qgis-ns-pe
pip install -e .

Verification

To verify the installation:

# Activate the environment (if not already activated)
conda activate qgis-env

# Try running the tool with --help
qgis-ns-pe --help

Usage

The tool can be used from the command line with the following syntax:

qgis-ns-pe --address "Your Address" --index_path "/path/to/lidar_index.gpkg" [--show_3d]

Example:

qgis-ns-pe --address "8 Alderwood Dr, Halifax, NS B3N 1S7" --index_path "/path/to/Index_LiDARtiles_tuileslidar.gpkg" --show_3d

Arguments

  • --address: The address to process (required)
  • --index_path: Path to the LiDAR index GPKG file (required)
  • --show_3d: Optional flag to show 3D visualizations of the point clouds

Output

The tool creates two directories:

  • lidar_tiles/: Contains downloaded LiDAR tiles
  • output/: Contains processed files:
    • sat.png: Satellite image of the location
    • lidar_cropped.laz: Cropped LiDAR point cloud
    • buildings.laz: Extracted building points

Troubleshooting

Common issues and solutions:

  1. QGIS not found: Make sure you've activated the conda environment with conda activate qgis-env
  2. Import errors: Ensure you're running the tool from the conda environment where QGIS is installed
  3. Missing dependencies: If you encounter any missing dependency errors, try installing them with conda first:
    conda install -c conda-forge <package-name>
    

Data Sources

  • LiDAR data: Nova Scotia and PEI government open data portals
  • Geocoding: OpenStreetMap Nominatim API
  • Satellite imagery: Mapbox Static Images API

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Authors

  • Amad Gakkhar - Initial work

Acknowledgments

  • QGIS Development Team
  • laspy contributors
  • OpenStreetMap contributors
  • Mapbox

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

qgis_ns_pe-0.1.0.tar.gz (12.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

qgis_ns_pe-0.1.0-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

Details for the file qgis_ns_pe-0.1.0.tar.gz.

File metadata

  • Download URL: qgis_ns_pe-0.1.0.tar.gz
  • Upload date:
  • Size: 12.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for qgis_ns_pe-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d9477bf4fd2fd128d6ce132801780332029356ad39ca2c67d1e8711f478aabf5
MD5 474055f68590615907fd54929e75e524
BLAKE2b-256 4ecbb43947f34d0a2d6e9e26ad27eb666f286589440f5c2f099162199c015c7a

See more details on using hashes here.

File details

Details for the file qgis_ns_pe-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: qgis_ns_pe-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 11.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for qgis_ns_pe-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f7377de30544455e7faef39e087375f1ae272dbff7d70386559e764735651442
MD5 12b2be1c7c979a2713e39a121f6a3567
BLAKE2b-256 76fb7f388a767db5c035131044a9d1d183550f45f40dae207fe51081c270429a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page