https://github.com/a-b-street/od2net

https://github.com/a-b-street/od2net

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 (13.6%) to scientific vocabulary
Last synced: 9 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: a-b-street
  • License: apache-2.0
  • Language: Rust
  • Default Branch: main
  • Homepage: https://od2net.org
  • Size: 20.6 MB
Statistics
  • Stars: 35
  • Watchers: 5
  • Forks: 9
  • Open Issues: 46
  • Releases: 0
Created almost 3 years ago · Last pushed over 1 year ago
Metadata Files
Readme License

README.md

od2net

Logo

WARNING: This repo is not ready for general use. The API and input/output formats will keep changing. There are big limitations not yet documented.

od2net helps you turn origin/destination data about where people travel into a cycling network plan. You can use this to decide what streets to prioritize for safety improvements.

  1. You specify origins and destinations of trips that cyclists take today or of short trips taken by car
  2. You specify how cyclists would like to choose routes. Are fast/direct routes important, or sticking to quiet streets? Do you want to route near greenspace and shops?)
  3. od2net calculates routes very quickly, counting how many routes cross every street
  4. You use the web viewer to look at the most popular streets, filtering for streets that don't have good cycling infrastructure today

How to use it

You can quickly try out od2net without installing anything:

Once you're ready to run in a large area with your own origin/destination data, then start with the tutorial and see all documentation. Again note this project status is still pre-alpha; docs are not all written yet.

Installation

shell cargo install --locked --git https://github.com/Urban-Analytics-Technology-Platform/od2net

Docker

You can run the application with Docker, e.g. as follows:

shell sudo docker run -v $(pwd):/app ghcr.io/urban-analytics-technology-platform/od2net:main /app/config.json

With Python

See Python scripts in the examples directory, as described in the tutorial.

R package

There is a small R package with functions to help generate the input files needed by od2net. See documentation here.

Contributing

We'd love contributions of all sorts -- developers, designers, data scientists, and applying it somewhere new! Check out GitHub Issues, file a new one, or email dabreegster@gmail.com to get started.

This project follows the Rust code of conduct and is Apache 2.0 licensed. See all credits.

Owner

  • Name: A/B Street
  • Login: a-b-street
  • Kind: organization
  • Email: dabreegster@gmail.com
  • Location: Seattle, WA

Transportation planning and traffic simulation software for creating cities friendlier to walking, biking, and public transit

GitHub Events

Total
  • Issues event: 2
  • Watch event: 2
  • Issue comment event: 5
Last Year
  • Issues event: 2
  • Watch event: 2
  • Issue comment event: 5

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 64
  • Total pull requests: 30
  • Average time to close issues: 27 days
  • Average time to close pull requests: 6 days
  • Total issue authors: 8
  • Total pull request authors: 7
  • Average comments per issue: 2.91
  • Average comments per pull request: 1.37
  • Merged pull requests: 24
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 19
  • Pull requests: 11
  • Average time to close issues: 6 days
  • Average time to close pull requests: about 19 hours
  • Issue authors: 6
  • Pull request authors: 4
  • Average comments per issue: 2.68
  • Average comments per pull request: 1.36
  • Merged pull requests: 9
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • dabreegster (30)
  • Robinlovelace (7)
  • matkoniecz (1)
Pull Request Authors
  • Robinlovelace (11)
  • dabreegster (11)
  • stuartlynn (2)
  • wangzhao0217 (1)
  • panjacek (1)
  • KDKasonde (1)
  • andrewphilipsmith (1)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/docker.yml actions
  • actions/checkout v4 composite
  • docker/build-push-action f2a1d5e99d037542a71f64918e516c093c6f3fc4 composite
  • docker/login-action 65b78e6e13532edd9afa3aa52ac7964289d1a9c1 composite
  • docker/metadata-action 9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7 composite
od2net/Cargo.toml cargo
examples/seattle/setup.py pypi
.github/workflows/web.yml actions
  • actions/cache v3 composite
  • actions/checkout v2 composite
  • actions/setup-node v3 composite
  • jetli/wasm-pack-action v0.4.0 composite
  • peaceiris/actions-gh-pages v3 composite
Cargo.lock cargo
  • 133 dependencies
Cargo.toml cargo
lts/Cargo.toml cargo
Dockerfile docker
  • debian bookworm-slim build
  • rust latest build
viewer/package-lock.json npm
  • 242 dependencies
viewer/package.json npm
  • @ianvs/prettier-plugin-sort-imports ^4.0.2 development
  • @sveltejs/vite-plugin-svelte ^2.4.2 development
  • @tsconfig/svelte ^4.0.1 development
  • prettier ^2.8.8 development
  • prettier-plugin-svelte ^2.10.1 development
  • svelte ^4.0.0 development
  • svelte-check ^3.4.4 development
  • tslib ^2.6.0 development
  • typescript ^5.1.3 development
  • vite ^4.3.9 development
  • vite-plugin-wasm-pack 0.1.11 development
  • pmtiles ^2.10.0
  • svelte-maplibre ^0.3.1
examples/edinburgh/setup.py pypi
examples/england_2011_home_to_work/setup.py pypi
examples/liverpool/setup.py pypi
examples/london/setup.py pypi
examples/york/setup.py pypi
wasm-od2net/Cargo.toml cargo