Skip to main content

Sudan-focused Python toolkit for Geomatics: GIS, remote sensing, and surveying workflows.

Project description

SudaPy

Sudan-focused Python toolkit for Geomatics -- GIS, remote sensing, and surveying workflows that are fast, reliable, reproducible, and easy to install.

SudaPy is designed for Sudanese GIS professionals who need a single toolkit that works on Windows, handles common coordinate systems used in Sudan, and provides both a Python API and a friendly command-line interface.

Features

  • Built-in CRS presets for Sudan (WGS 84 UTM 34-37N, Adindan UTM 35-37N)
  • Vector operations: reproject, clip, dissolve, area, buffer, simplify, fix-geometry
  • Raster operations: clip, reproject, resample, mosaic, hillshade, slope
  • Quick map export (PNG or interactive HTML)
  • Project scaffolding (sudapy init), batch processing, and data reporting
  • Environment diagnostics (sudapy doctor)
  • Remote sensing helpers (Sentinel search/download) via optional extras
  • Offline-friendly installation support
  • Modern Python packaging with optional extras

Installation

From PyPI (recommended)

# Core toolkit
pip install sudapy

# With remote-sensing extras
pip install "sudapy[rs]"

# With visualization extras
pip install "sudapy[viz]"

# Everything
pip install "sudapy[all]"

Using conda for geospatial dependencies

Some geospatial libraries (GDAL, rasterio, fiona) can be difficult to install from pip on Windows. Using conda or mamba to install binary dependencies first is recommended:

conda create -n sudapy python=3.11
conda activate sudapy
conda install -c conda-forge geopandas rasterio fiona pyproj
pip install sudapy

An environment.yml is included in the repository for a known-good conda environment:

conda env create -f environment.yml
conda activate sudapy

Offline installation

See Offline Installation Guide for instructions on installing SudaPy without internet access.

Quickstart

1. Check your environment

sudapy doctor

2. Find the right CRS for a location in Sudan

# What UTM zone covers Khartoum?
sudapy crs suggest --lon 32.5 --lat 15.6

3. Reproject a vector file

sudapy vector reproject --in data/regions.gpkg --out data/regions_utm.gpkg --to 32636

4. Calculate area

sudapy vector area --in data/parcels.gpkg --field area_m2 --out data/parcels_area.gpkg

5. Quick map

# Static PNG
sudapy map quick --in data/regions.gpkg --out map.png

# Interactive HTML
sudapy map quick --in data/regions.gpkg --out map.html

6. Scaffold a new project

sudapy init my_survey_project

7. Get a report on a dataset

sudapy report --in data/parcels.gpkg

Python API

from sudapy.crs.registry import suggest_utm_zone, list_presets
from sudapy.vector.ops import reproject, calculate_area, clip, dissolve, buffer, simplify

# Suggest CRS for a point
suggestions = suggest_utm_zone(lon=32.5, lat=15.6)

# Reproject a file
gdf = reproject("input.gpkg", to_epsg=32636, out="output.gpkg")

# Calculate area with automatic UTM projection
gdf = calculate_area("parcels.gpkg", field="area_m2", out="parcels_area.gpkg")

# Buffer with meters (auto-projects if CRS is geographic)
gdf = buffer("points.gpkg", distance_m=500, out="buffered.gpkg")

Project Structure

src/sudapy/
    __init__.py
    core/
        logging.py      # Rich-based logging
        errors.py       # Custom exceptions with hints
    cli/
        main.py         # Typer CLI application
    crs/
        registry.py     # Sudan CRS presets and UTM suggestion
    vector/
        ops.py          # Vector geoprocessing
    raster/
        ops.py          # Raster geoprocessing
    viz/
        maps.py         # Quick map visualization
    rs/
        sentinel.py     # Sentinel satellite search & download

Development

git clone https://github.com/Osman-Geomatics93/sudapy.git
cd sudapy
pip install -e ".[dev,all]"
pytest
ruff check src/ tests/

Changelog

See CHANGELOG.md for release history.

License

MIT

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

sudapy-0.1.0.tar.gz (24.2 kB view details)

Uploaded Source

Built Distribution

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

sudapy-0.1.0-py3-none-any.whl (23.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sudapy-0.1.0.tar.gz
  • Upload date:
  • Size: 24.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.0

File hashes

Hashes for sudapy-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d18bb7ffa1fad179b86698bb00b03df772342a2e88d46eebaa01cfe067fc8a41
MD5 4b9d3c3c336c980f676b7439cc0b170c
BLAKE2b-256 fbe986f4485eecb6c3f0cd67d1ee1ff332223b645f71bc79308acea545924e60

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sudapy-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 23.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.0

File hashes

Hashes for sudapy-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 02a18c308e10cdc29511040a508e5bdb9dfae6564c1d53ae31405fc92d6548c2
MD5 f978a7d9f67d94cf3b932ddc4f7fbc65
BLAKE2b-256 a218477dc9a012eff4250ed20601073327b540adf96507f0ffb6d5fa9d1bc587

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