https://github.com/cyclingmoritz/urbanbikeflow

Repository for my master thesis where I will be Modeling Bicycle and Scooter Flow on Barcelona’s Bike Lanes

https://github.com/cyclingmoritz/urbanbikeflow

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.4%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Repository for my master thesis where I will be Modeling Bicycle and Scooter Flow on Barcelona’s Bike Lanes

Basic Info
  • Host: GitHub
  • Owner: cyclingMoritz
  • Language: Python
  • Default Branch: main
  • Size: 20.5 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 1 year ago · Last pushed over 1 year ago
Metadata Files
Readme

README.md

UrbanBikeFlow

A Python project structured using Cookiecutter Data Science, with UV for dependency management and GitHub for version control.

📂 Project Structure

This project follows the Cookiecutter Data Science template:

├── README.md # Project overview and instructions ├── data/ # Data storage (not tracked by Git) │ ├── external/ # Data from external sources │ ├── interim/ # Intermediate data transformations │ ├── raw/ # Original data │ └── processed/ # Final processed data ├── docs/ # Documentation ├── models/ # Trained models and outputs ├── notebooks/ # Jupyter notebooks ├── reports/ # Generated analysis and figures │ └── figures/ # Visual outputs and plots ├── src/urbanbikeflow # Source code │ ├── __init__.py # Package initialization │ └── utilities.py # Package initialization └── pyproject.toml # Project metadata and dependencies

🚀 Getting Started

Prerequisites

Ensure UV is installed:

bash pip install uv

Setup Instructions

  1. Clone the repository:

bash git clone https://github.com/cyclingMoritz/UrbanBikeFlow.git cd UrbanBikeFlow

  1. Create and activate a virtual environment:

bash uv venv source .venv/bin/activate # Linux/macOS .venv\Scripts\activate # Windows

  1. Install dependencies from pyproject.toml:

bash uv sync

  1. Run the main script:

bash python src/main.py

📦 Managing Dependencies

Add new packages using UV:

bash uv pip install package-name

Update the pyproject.toml by syncing dependencies:

bash uv pip freeze > pyproject.toml

📊 Project Workflow

  1. Add your code under src/.
  2. Use notebooks/ for experiments.
  3. Organize data into data/external, data/interim, data/raw, and data/processed.
  4. Store models in models/.
  5. Save reports and figures in reports/ and reports/figures/.

🔗 Contributing

  1. Fork the repository and create a feature branch:

bash git checkout -b feature/your-feature

  1. Make changes and commit:

bash git add . git commit -m "Add new feature"

  1. Push and open a pull request:

bash git push origin feature/your-feature

📜 License

This project is licensed under the MIT License. See LICENSE for details.

Owner

  • Login: cyclingMoritz
  • Kind: user

GitHub Events

Total
  • Push event: 4
  • Create event: 2
Last Year
  • Push event: 4
  • Create event: 2

Dependencies

pyproject.toml pypi
  • cookiecutter >=2.6.0
uv.lock pypi
  • arrow 1.3.0
  • binaryornot 0.4.4
  • certifi 2025.1.31
  • chardet 5.2.0
  • charset-normalizer 3.4.1
  • click 8.1.8
  • colorama 0.4.6
  • cookiecutter 2.6.0
  • idna 3.10
  • jinja2 3.1.6
  • markdown-it-py 3.0.0
  • markupsafe 3.0.2
  • mdurl 0.1.2
  • pygments 2.19.1
  • python-dateutil 2.9.0.post0
  • python-slugify 8.0.4
  • pyyaml 6.0.2
  • requests 2.32.3
  • rich 13.9.4
  • six 1.17.0
  • text-unidecode 1.3
  • types-python-dateutil 2.9.0.20241206
  • urbanbikeflow 0.1.0
  • urllib3 2.3.0