qgis-ns-pe


Nameqgis-ns-pe JSON
Version 0.1.3 PyPI version JSON
download
home_pageNone
SummaryA CLI tool for processing LiDAR data from Nova Scotia and PEI using QGIS
upload_time2025-07-10 06:50:56
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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 three steps: setting up QGIS, installing dependencies, and installing this package.

### 1. Install QGIS using Conda

First, create a new conda environment with QGIS installed:

```bash
# 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 Dependencies

Install required dependencies using conda:

```bash
conda install -c conda-forge pyproj numpy matplotlib
conda install -c conda-forge laspy lazrs
```

### 3. Install qgis-ns-pe

After activating the conda environment and installing dependencies, install this package:

```bash
# For users: install from PyPI (not yet available)
# 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 .
```

### Package Structure

The package should have the following structure:

```
qgis-ns-pe/
├── qgis_ns_pe/
│   ├── __init__.py
│   └── cli.py
├── setup.py
└── README.md
```

### Verification

To verify the installation:

```bash
# Make sure you're in the conda environment
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:

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

Example:
```bash
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:
   ```bash
   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

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "qgis-ns-pe",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Amad Gakkhar <amad.gakkhar@adept-techsolutions.com>",
    "download_url": "https://files.pythonhosted.org/packages/17/13/0b7d905dd6a9307b1b912d2c6a61090db4b1b1105ebc8300ab43c211a89f/qgis_ns_pe-0.1.3.tar.gz",
    "platform": null,
    "description": "# QGIS Nova Scotia & PEI LiDAR Processing Tool\n\nA command-line tool for processing LiDAR data from Nova Scotia and Prince Edward Island using QGIS. This tool allows you to:\n\n- Geocode addresses in Nova Scotia and PEI\n- Download and process LiDAR point cloud data\n- Extract building footprints from LiDAR data\n- Generate satellite imagery for the location\n- Visualize 3D point clouds\n\n## Features\n\n- Address geocoding using OpenStreetMap Nominatim API\n- Coordinate transformation between different CRS (WGS84, NAD83(CSRS), MTM zone 5)\n- LiDAR point cloud processing using laspy\n- Building point extraction\n- 3D visualization capabilities\n- Satellite imagery retrieval from Mapbox\n\n## Prerequisites\n\n- Python 3.8 or higher\n- QGIS 3.22.0 or higher\n- Conda (required for QGIS installation)\n\n## Installation\n\nThe installation process has three steps: setting up QGIS, installing dependencies, and installing this package.\n\n### 1. Install QGIS using Conda\n\nFirst, create a new conda environment with QGIS installed:\n\n```bash\n# Create a new environment with QGIS and Python 3.8\nconda create -n qgis-env -c conda-forge qgis python=3.8\n\n# Activate the environment\nconda activate qgis-env\n```\n\n### 2. Install Dependencies\n\nInstall required dependencies using conda:\n\n```bash\nconda install -c conda-forge pyproj numpy matplotlib\nconda install -c conda-forge laspy lazrs\n```\n\n### 3. Install qgis-ns-pe\n\nAfter activating the conda environment and installing dependencies, install this package:\n\n```bash\n# For users: install from PyPI (not yet available)\n# pip install qgis-ns-pe\n\n# For developers: install in editable mode from source\ngit clone https://github.com/amadgakkhar/qgis-ns-pe.git\ncd qgis-ns-pe\npip install -e .\n```\n\n### Package Structure\n\nThe package should have the following structure:\n\n```\nqgis-ns-pe/\n\u251c\u2500\u2500 qgis_ns_pe/\n\u2502   \u251c\u2500\u2500 __init__.py\n\u2502   \u2514\u2500\u2500 cli.py\n\u251c\u2500\u2500 setup.py\n\u2514\u2500\u2500 README.md\n```\n\n### Verification\n\nTo verify the installation:\n\n```bash\n# Make sure you're in the conda environment\nconda activate qgis-env\n\n# Try running the tool with --help\nqgis-ns-pe --help\n```\n\n## Usage\n\nThe tool can be used from the command line with the following syntax:\n\n```bash\nqgis-ns-pe --address \"Your Address\" --index_path \"/path/to/lidar_index.gpkg\" [--show_3d]\n```\n\nExample:\n```bash\nqgis-ns-pe --address \"8 Alderwood Dr, Halifax, NS B3N 1S7\" --index_path \"/path/to/Index_LiDARtiles_tuileslidar.gpkg\" --show_3d\n```\n\n### Arguments\n\n- `--address`: The address to process (required)\n- `--index_path`: Path to the LiDAR index GPKG file (required)\n- `--show_3d`: Optional flag to show 3D visualizations of the point clouds\n\n### Output\n\nThe tool creates two directories:\n- `lidar_tiles/`: Contains downloaded LiDAR tiles\n- `output/`: Contains processed files:\n  - `sat.png`: Satellite image of the location\n  - `lidar_cropped.laz`: Cropped LiDAR point cloud\n  - `buildings.laz`: Extracted building points\n\n## Troubleshooting\n\nCommon issues and solutions:\n\n1. **QGIS not found**: Make sure you've activated the conda environment with `conda activate qgis-env`\n2. **Import errors**: Ensure you're running the tool from the conda environment where QGIS is installed\n3. **Missing dependencies**: If you encounter any missing dependency errors, try installing them with conda first:\n   ```bash\n   conda install -c conda-forge <package-name>\n   ```\n\n## Data Sources\n\n- LiDAR data: Nova Scotia and PEI government open data portals\n- Geocoding: OpenStreetMap Nominatim API\n- Satellite imagery: Mapbox Static Images API\n\n## License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## Authors\n\n- Amad Gakkhar - Initial work\n\n## Acknowledgments\n\n- QGIS Development Team\n- laspy contributors\n- OpenStreetMap contributors\n- Mapbox\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A CLI tool for processing LiDAR data from Nova Scotia and PEI using QGIS",
    "version": "0.1.3",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "6f929d95a84d989f1dcf708cf6a48447c620d50f7044dbd618f1f4dc8cb539ae",
                "md5": "cfcbe070d2b136378d7354e2c0f5a125",
                "sha256": "0c8abb8c9a450d1554fd10904765064ffec84a76ef2b0ad1c8cb51c6b3a2f848"
            },
            "downloads": -1,
            "filename": "qgis_ns_pe-0.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "cfcbe070d2b136378d7354e2c0f5a125",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 16060,
            "upload_time": "2025-07-10T06:50:54",
            "upload_time_iso_8601": "2025-07-10T06:50:54.978381Z",
            "url": "https://files.pythonhosted.org/packages/6f/92/9d95a84d989f1dcf708cf6a48447c620d50f7044dbd618f1f4dc8cb539ae/qgis_ns_pe-0.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "17130b7d905dd6a9307b1b912d2c6a61090db4b1b1105ebc8300ab43c211a89f",
                "md5": "3e4b957dd475e6d086d199ee874b98c0",
                "sha256": "952149c4c83a2f619291e2aeca8657d56cb31076685d9ff8cf08bcb05a95674b"
            },
            "downloads": -1,
            "filename": "qgis_ns_pe-0.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "3e4b957dd475e6d086d199ee874b98c0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 17363,
            "upload_time": "2025-07-10T06:50:56",
            "upload_time_iso_8601": "2025-07-10T06:50:56.256031Z",
            "url": "https://files.pythonhosted.org/packages/17/13/0b7d905dd6a9307b1b912d2c6a61090db4b1b1105ebc8300ab43c211a89f/qgis_ns_pe-0.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-10 06:50:56",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "qgis-ns-pe"
}
        
Elapsed time: 1.44746s