Metadata-Version: 2.4
Name: linkbikenet
Version: 0.8.3
Summary: BikeNetKit Python package to link disconnected bicycle network components
Author: Manuel Knepper, Luis Guillermo Natera Orozco
Author-email: Michael Szell <michael@szell.net>
Maintainer-email: Michael Szell <michael@szell.net>
License-Expression: AGPL-3.0-or-later
Project-URL: Homepage, https://bikenetkit.org/linkbikenet/
Project-URL: Documentation, https://docs.bikenetkit.org/LinkBikeNet/
Project-URL: Repository, https://github.com/BikeNetKit/LinkBikeNet/
Project-URL: Issues, https://github.com/BikeNetKit/LinkBikeNet/issues/
Project-URL: Changelog, https://docs.bikenetkit.org/LinkBikeNet/changelog/
Keywords: Bicycle network planning,Networks,OpenStreetMap,Urban Planning,Urban Mobility
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Natural Language :: English
Classifier: Topic :: Scientific/Engineering :: GIS
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: geopandas>=1
Requires-Dist: osmnx>=2
Requires-Dist: scipy
Requires-Dist: geojson
Requires-Dist: tqdm
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Provides-Extra: doc
Requires-Dist: sphinx; extra == "doc"
Dynamic: license-file

# <a href="https://docs.bikenetkit.org/LinkBikeNet/"><img src="https://github.com/BikeNetKit/LinkBikeNet/raw/main/docs/source/_static/logo_linkbikenet.svg" alt="LinkBikeNet" width="276.6" height="59"></a>

[![Conda Version](https://img.shields.io/conda/vn/conda-forge/linkbikenet?color=10d249)](https://anaconda.org/conda-forge/linkbikenet)
[![PyPI - Version](https://img.shields.io/pypi/v/linkbikenet?color=10d249)](https://pypi.org/project/LinkBikeNet/)
[![Docs](https://github.com/BikeNetKit/LinkBikeNet/actions/workflows/docs.yml/badge.svg)](https://docs.bikenetkit.org/LinkBikeNet/)
[![Test](https://github.com/BikeNetKit/LinkBikeNet/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/BikeNetKit/LinkBikeNet/actions/workflows/test.yml)
[![Code coverage](https://codecov.io/gh/BikeNetKit/LinkBikeNet/graph/badge.svg)](https://codecov.io/gh/BikeNetKit/LinkBikeNet)
[![Mastodon Follow](https://img.shields.io/mastodon/follow/116693348622375119?domain=https%3A%2F%2Ffosstodon.org)](https://fosstodon.org/@BikeNetKit)

The Python package `linkbikenet` finds links between the disconnected components in a city's bicycle network. You can download street and bike network data with a single line of code, simulate different bicycle network linking scenarios, and export and plot the resulting prioritized linking steps.

> [!NOTE]
> LinkBikeNet is currently in Beta: It is core-feature complete, stable to use, but could still contain bugs. More features and breaking changes may be added anytime. Please [let us know](https://github.com/BikeNetKit/LinkBikeNet/issues) if you find issues or ways to improve.

[![Example Budapest](https://github.com/BikeNetKit/LinkBikeNet/raw/main/docs/source/_static/linkbikenet-budapest.gif)](https://bikenetkit.org/linkbikenet)

LinkBikeNet is a decision support tool for urban planners. It is also useful for proactive citizens to create a compelling vision for urban cycling in their city, and it aims to foster research on bicycle networks. 

## When to use
LinkBikeNet works well for cities that have some bicycle infrastructure in the form of disconnected components. This is the case for most cities in Europe. Recommended example cities to link components: Budapest, Dublin, Tirana

For alternative approaches, consider using [GrowBikeNet](https://github.com/BikeNetKit/GrowBikeNet) or [FixBikeNet](https://github.com/BikeNetKit/FixBikeNet).

## Installation

### The easy way

The currently recommended way to install LinkBikeNet is using [`conda`](https://docs.conda.io/projects/conda/en/latest/index.html):

```
conda install linkbikenet
```

### Advanced and development installations
 See our [installation docs](https://docs.bikenetkit.org/LinkBikeNet/installation/) for details.

## Usage

We provide a minimum working example in two formats:

- Python script ([examples/mwe.py](examples/mwe.py))
- Jupyter notebook ([examples/mwe.ipynb](examples/mwe.ipynb))

## Docs
Find more information in our docs: [https://docs.bikenetkit.org/LinkBikeNet/](https://docs.bikenetkit.org/LinkBikeNet/)

## Origin
The source code builds on [the code from the research paper](https://github.com/nateraluis/bicycle-network-growth) _Data-driven strategies for optimal bicycle network growth_.

**Publication**: [https://doi.org/10.1098/rsos.201130](https://doi.org/10.1098/rsos.201130)

## How to cite
If you use LinkBikeNet, please cite the paper:

> L.G. Natera Orozco, F. Battiston, G. Iñiguez, M. Szell. Data-driven strategies for optimal bicycle network growth. Royal Society Open Science 7:201130 (2020)
> DOI: [10.1098/rsos.201130](https://doi.org/10.1098/rsos.201130)

## Supported by
Development of BikeNetKit/LinkBikeNet is supported by the [Innovation Fund Denmark](https://innovationsfonden.dk/en) and the EU HORIZON project [JUST STREETS](https://www.just-streets.eu).

[![Innovation Fund Denmark](https://raw.githubusercontent.com/BikeNetKit/.github/refs/heads/main/profile/_static/logo_innovationfund.png)](https://innovationsfonden.dk/en) &emsp;&emsp; [![European Union](https://raw.githubusercontent.com/BikeNetKit/.github/refs/heads/main/profile/_static/logo_eu.png)](https://commission.europa.eu/index_en) &ensp; [![JUST STREETS](https://raw.githubusercontent.com/BikeNetKit/.github/refs/heads/main/profile/_static/logo_juststreets.png)](https://www.just-streets.eu/) 

Developed by  
<a href="https://nerds.itu.dk"><img src="https://raw.githubusercontent.com/BikeNetKit/.github/refs/heads/main/profile/_static/logo_nerds.png" alt="Networks, Data, and Society" width="280"></a>
