Skip to content

Latest commit

 

History

History
42 lines (30 loc) · 1.38 KB

README.md

File metadata and controls

42 lines (30 loc) · 1.38 KB
Raw

VelibFlow 🚲

VelibFlow is a machine learning project that aims to predict the availability of bikes and free parking spots in Vélib stations. By leveraging predictive algorithms, users can anticipate the availability of bikes and make informed decisions, and the Velib company can optimize the redistribution flow within the bike-sharing system.

Getting Started

To get started with VelibFlow, follow the instructions below:

Prerequisites

Python >= 3.6

Installation

  1. Clone the repository: 
    git clone https://github.com/giovannimin/VelibFlow.git
  2. Install dependencies: pip install -r requirements.txt

Token Setup

  1. Create a new plotly.express token 
    A Mapbox token is needed for figures from plotly.express.
See https://docs.mapbox.com/help/how-mapbox-works/access-tokens/ for more details
  2. Paste this token into a token.txt file located on root
  3. Add this token.txt file to the .gitignore

Contributing

Contributions to VelibFlow are welcome! If you'd like to contribute, please follow these steps:

  1. Fork the repository.
  2. Create a new branch.
  3. Make your changes and commit them.
  4. Push your changes to your forked repository.
  5. Submit a pull request detailing your changes.

Acknowledgements

OpenData from Vélib Métropole : https://www.velib-metropole.fr/donnees-open-data-gbfs-du-service-velib-metropole