/GeoKMLAnalyzer

The Geo Kml Analyzer is a Python-based tool designed to process and analyze elevation data from KML files. Uses google maps to obtain elevation data (interpolates if necessary) and spherical trigonometry equations to calculate the distance.

Primary LanguagePythonMIT LicenseMIT

Geo KML Analyzer

Python License: MIT PRs Welcome

Overview

The Geo Kml Analyzer is a Python-based tool designed to process and analyze elevation data from KML files. The tool reads KML files, extracts latitude and longitude coordinates, calculates distances between consecutive points, fetches elevation data from the Google Maps Elevation API, and generates descriptive statistics and plots for elevation profiles. Additionally, it supports including pins from separate KML files, finding the closest points on the route to these pins, and displaying them on the plots. This project aims to help users visualize and understand elevation profiles of geographical paths, such as hiking trails, roads, or pipelines.

Features

Data Processing and Analysis

  • Reads and processes KML files containing latitude and longitude data
  • Supports optional KML files with pins for labeling specific points on the route
  • Calculates distances between consecutive latitude and longitude pairs using the Vincenty formula
  • Fetches elevation data from the Google Maps Elevation API
  • Interpolates (up to 512 times) within the data to target a resolution distance of 1 meter
  • Generates descriptive statistics for distance, elevation, latitude, and longitude
  • Exports processed data to CSV files

Visualization

  • Creates plots for elevation profiles against sample count and distance
  • Includes pin labels on plots, automatically adjusting their positions to avoid overlap

User Interface

  • Converts KML files to CSV format for easy data manipulation
  • Saves plots as images
  • Displays a progress bar to track the processing status

TODO

  • Optimize number of requests for the data size. Pass arrays of data and limit to 8192 characters.

Installation

  1. Clone the repository to your local machine:
git clone https://github.com/josmarcristello/GeoKMLAnalyzer.git
  1. Change into the project directory:
cd elevation-profile-analyzer
  1. Create a virtual environment and activate it:
python3 -m venv venv
source venv/bin/activate
  1. Install the required packages:
pip install -r requirements.txt

Usage

  1. Create a .env file and include your Google maps API key (API_KEY). Example is not a valid key.
API_KEY = 'DCzaXyRrSW1e-7Fx2YEZlSLv81cYc3__-5ndsfFG'

  1. Place your KML files in the data/kml directory. I have included a source file for test purposes.

  2. Run the main script:

python src/kmz_to_csv.py

  1. Processed data and plot images will be stored in the output directory.

  2. To run descriptive statistics run the notebook:

src/notebook/get-google-maps-altitude

You can explore the generated descriptive statistics and plots to analyze elevation profiles for your KML files.

Sample Images

Progress bar:

Progress Bar

Altitude x Distance Plot:

Altitude x Distance Plot

Notes

Google Maps API charges approximately 5 USD / 1 000 requests, depending on volume. They also gives $200 USD in credits every month, so that translates to 40 000 free requests per month.

Contributing

We welcome contributions to improve this project. Please submit a pull request with your proposed changes, and ensure your code follows the project's style guidelines and best practices.

License

This project is licensed under the MIT License. Please see the LICENSE file for more information.