Giter Club home page Giter Club logo

elena-cs520's Introduction

EleNa: Elevation-based Navigation

Navigation systems optimize for the shortest or fastest route. However, they do not consider elevation gain. Let’s say you are hiking or biking from one location to another. You may want to literally go the extra mile if that saves you a couple thousand feet in elevation gain. Likewise, you may want to maximize elevation gain if you are looking for an intense yet time-constrained workout.

The high-level goal of this project is to develop a software system that determines, given a start and an end location, a route that maximizes or minimizes elevation gain, while limiting the total distance between the two locations to x% of the shortest path.

user input

APIs

We get our graph data using the OpenStreetMap(OSM) API which returns a networkx multidigraph of the city. Since OSM does not provide elevation data, we use Open-Elevation API to retrieve the elevation data for each node of the graph. We also use the OSM API to get the default shortest path between a start and end location. We compare and test our paths against this path for accuracy.

Python GUI

The GUI interface allows the user to view the path returned by the chosen algorithm and the corresponding information such as total elevation and total distance of the path compared with the shortest path possible. The GUI utilizes the OSM API to visualize the path in the city's graph and tkinter to display the corresponding data.

plotted paths

Red is the path returned by our program and blue is the default shortest path.

path summary window

Here we can see a summary of the path including the total path elevation and total path distance compared with the shortest path.

Note: Tkinter may need to be installed manually according to your operating system

How to Run

To use EleNa on your system, run pip3 install -r requirements.txt in the root directory of EleNa. This will get you all the needed Python dependencies for you to run the project locally.

Then, simply run python3 src/app.py in the root directory. Now, you will be prompted to enter details of yours desired travel, such as start and end addresses, preferred routing algorithm, mode of transporation, etc.

Note: The current version of EleNa uses Boulder, Colorado's map so only addresses in Boulder will work. We are using a cached version of the Boulder map that was downloaded on 11/8/2021. If you would like to download an updated copy of the map or use the map of a different city please run:

python src/map.py <city> <state> <country> from the root directory.

How to Validate

We have written a series of tests for the Dijkstra and A* algorithms. To run the tests, run pytest in the root directory.

NOTE: This app has only been tested with Python3

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.