Skip to content

Latest commit

 

History

History
247 lines (201 loc) · 10.5 KB

README.md

File metadata and controls

247 lines (201 loc) · 10.5 KB
Raw


toolkit_for_gps_mobility_data_analysis

📍 GitHub: Unlocking the Power of GPS Mobility Data Analysis!

🚀 Developed with the software and tools below.

sklearn sample javascript datetime infomap css png

📚 Table of Contents

📍Overview

The toolkit_for_gps_mobility_data_analysis is a Python package designed for comprehensive analysis of GPS-based mobility data. It offers a user-friendly API to facilitate the processing and analysis of GPS data, making it an essential tool for researchers and developers working in the field of mobility analysis.

🔮 Feautres

  • Data Processing: Efficient handling and processing of large-scale GPS data.
  • Analysis Tools: Advanced tools for analyzing mobility patterns, stops, and routes.
  • Customizable Workflows: Flexible architecture to adapt to various analysis needs.

⚙️ Project Structure

repo
├── cpputils
│   └── main.cpp
├── docs
│   ├── build
│   │   ├── doctrees
│   │   │   ├── environment.pickle
│   │   │   ├── index.doctree
│   │   │   ├── intro.doctree
│   │   │   ├── modules.doctree
│   │   │   └── wbgps.doctree
│   │   └── html
│   │       ├── genindex.html
│   │       ├── index.html
│   │       ├── intro.html
│   │       ├── _modules
│   │       │   ├── index.html
│   │       │   └── wbgps
│   │       │       ├── analysis.html
│   │       │       ├── labeling.html
│   │       │       └── stops.html
│   │       ├── modules.html
│   │       ├── objects.inv
│   │       ├── py-modindex.html
│   │       ├── search.html
│   │       ├── searchindex.js
│   │       ├── _sources
│   │       │   ├── index.rst.txt
│   │       │   ├── intro.rst.txt
│   │       │   ├── modules.rst.txt
│   │       │   └── wbgps.rst.txt
│   │       ├── _static
│   │       │   ├── basic.css
│   │       │   ├── css
│   │       │   │   ├── badge_only.css
│   │       │   │   ├── fonts
│   │       │   │   │   ├── fontawesome-webfont.eot
│   │       │   │   │   ├── fontawesome-webfont.svg
│   │       │   │   │   ├── fontawesome-webfont.ttf
│   │       │   │   │   ├── fontawesome-webfont.woff
│   │       │   │   │   ├── fontawesome-webfont.woff2
│   │       │   │   │   ├── lato-bold-italic.woff
│   │       │   │   │   ├── lato-bold-italic.woff2
│   │       │   │   │   ├── lato-bold.woff
│   │       │   │   │   ├── lato-bold.woff2
│   │       │   │   │   ├── lato-normal-italic.woff
│   │       │   │   │   ├── lato-normal-italic.woff2
│   │       │   │   │   ├── lato-normal.woff
│   │       │   │   │   ├── lato-normal.woff2
│   │       │   │   │   ├── Roboto-Slab-Bold.woff
│   │       │   │   │   ├── Roboto-Slab-Bold.woff2
│   │       │   │   │   ├── Roboto-Slab-Regular.woff
│   │       │   │   │   └── Roboto-Slab-Regular.woff2
│   │       │   │   └── theme.css
│   │       │   ├── doctools.js
│   │       │   ├── documentation_options.js
│   │       │   ├── file.png
│   │       │   ├── js
│   │       │   │   ├── badge_only.js
│   │       │   │   ├── html5shiv.min.js
│   │       │   │   ├── html5shiv-printshiv.min.js
│   │       │   │   └── theme.js
│   │       │   ├── language_data.js
│   │       │   ├── minus.png
│   │       │   ├── plus.png
│   │       │   ├── pygments.css
│   │       │   ├── searchtools.js
│   │       │   └── sphinx_highlight.js
│   │       └── wbgps.html
│   ├── make.bat
│   ├── Makefile
│   └── source
│       ├── conf.py
│       ├── index.rst
│       ├── intro.rst
│       ├── modules.rst
│       └── wbgps.rst
├── LICENSE
├── README.md
├── requirements.txt
├── setup.py
└── wbgps
    ├── analysis.py
    ├── __init__.py
    ├── labeling.py
    └── stops.py

14 directories, 71 files

💻 Modules

Wbgps
File Summary Module
labeling.py This code imports the necessary packages and functions to create a dataframe with user_id , start and end times , duration , latitude and longitude , total duration and pings at a stop location , cluster label , median accuracy , location type , wbgps/labeling.py
stops.py This code contains functions to apply the Infostop algorithm to a set of geolocated pings with timestamps . It validates the data frame , computes intervals , converts dates to UNIX time , and applies the DBSCAN wbgps/stops.py
analysis.py Prompt too long to generate summary. wbgps/analysis.py

🚀 Getting Started

✅ Prerequisites

Before you begin, ensure that you have the following prerequisites installed:

  • Pyspark 3 <

There is an development environment in the infrastructure directory. You would need to install docker-compose [https://docs.docker.com/compose/] and run the following command in the mentioned directory:

docker-compose up

This gives you all the requirements for running a Spark cluster in your local machine using docker containers.

💻 Installation

  1. Clone the toolkit_for_gps_mobility_data_analysis repository:
git clone https://github.com/spfraib/toolkit_for_gps_mobility_data_analysis
  1. Change to the project directory:
cd toolkit_for_gps_mobility_data_analysis
  1. Install the package:
pip install .

🤖 Using toolkit_for_gps_mobility_data_analysis

import wbgps

🧪 Tests

Check out our example notebook for a quick demonstration of how to use the toolkit.

🛠 Future Development

  • [📌 COMPLETED-TASK]
  • [📌 INSERT-TASK]
  • [📌 INSERT-TASK]

🤝 Contributing

Contributions are always welcome! Please follow these steps:

  1. Fork the project repository. This creates a copy of the project on your account that you can modify without affecting the original project.
  2. Clone the forked repository to your local machine using a Git client like Git or GitHub Desktop.
  3. Create a new branch with a descriptive name (e.g., new-feature-branch or bugfix-issue-123).
git checkout -b new-feature-branch
  1. Make changes to the project's codebase.
  2. Commit your changes to your local branch with a clear commit message that explains the changes you've made.
git commit -m 'Implemented new feature.'
  1. Push your changes to your forked repository on GitHub using the following command
git push origin new-feature-branch
  1. Create a pull request to the original repository. Open a new pull request to the original project repository. In the pull request, describe the changes you've made and why they're necessary. The project maintainers will review your changes and provide feedback or merge them into the main branch.

🪪 License

🙏 Acknowledgments