Metadata-Version: 2.4
Name: growbikenet
Version: 0.8.0
Summary: BikeNetKit Python package to grow urban bicycle networks
Author: Manuel Knepper, Anastassia Vybornova, Michael Szell
Maintainer-email: Manuel Knepper <manuel.knepper@gmx.net>
License-Expression: AGPL-3.0-or-later
Project-URL: Repository, https://github.com/BikeNetKit/GrowBikeNet
Project-URL: Issues, https://github.com/BikeNetKit/GrowBikeNet/issues
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: Natural Language :: English
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: geopandas>=0.14
Requires-Dist: matplotlib
Requires-Dist: osmnx>=1.9.4
Requires-Dist: geojson
Requires-Dist: tqdm
Requires-Dist: pip
Requires-Dist: momepy
Requires-Dist: opencv-python
Requires-Dist: python-slugify
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Provides-Extra: doc
Requires-Dist: sphinx; extra == "doc"
Requires-Dist: momepy; extra == "doc"
Dynamic: license-file

# Bike Net Kit / Grow Bike Net

[![Docs](https://github.com/BikeNetKit/GrowBikeNet/actions/workflows/docs.yml/badge.svg)](https://bikenetkit.github.io/GrowBikeNet/)
[![Test](https://github.com/BikeNetKit/GrowBikeNet/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/BikeNetKit/GrowBikeNet/actions/workflows/test.yml)
[![PyPI Version](https://badge.fury.io/py/growbikenet.svg)](https://pypi.org/project/growbikenet/)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

The Python package `growbikenet` grows an urban bicycle network from scratch or from an existing bicycle network. 

The software downloads and pre-processes data from OpenStreetMap, prepares seed points to connect, runs simulations, saves the results, create plots and videos. The source code builds on [the code from the research paper](https://github.com/mszell/bikenwgrowth) _Growing Urban Bicycle Networks_ and on [the code from the research paper](https://github.com/pietrofolco/Data-driven_bicycle_network_planning_for_demand_and_safety) _Data-driven micromobility network planning for demand and safety_.

**Publication** (primary): [https://doi.org/10.1038/s41598-022-10783-y](https://doi.org/10.1038/s41598-022-10783-y)  
**Publication** (secondary): [https://doi.org/10.1177/23998083221135611](https://doi.org/10.1177/23998083221135611)

## Installation

### The easy way

The currently best way to install GrowBikeNet is using pip:

```
pip install growbikenet
```

<!-- > [!IMPORTANT]  
> As of 2026-05-04, the conda-forge installation is not yet working. We will remove this note once it works.

The best way to install GrowBikeNet is using [`conda`](https://docs.conda.io/projects/conda/en/latest/index.html) and the `conda-forge` channel:

```
conda install -c conda-forge growbikenet
``` -->

If this does not work, consult our [installation docs](https://bikenetkit.github.io/GrowBikeNet/usage/installation/).

### Advanced and development installations
 See our [installation docs](https://bikenetkit.github.io/GrowBikeNet/usage/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://bikenetkit.github.io/GrowBikeNet/](https://bikenetkit.github.io/GrowBikeNet/)


## Supported by
Development of BikeNetKit/GrowBikeNet was supported by the Innovation Fund Denmark and the EU HORIZON grant JUST STREETS.

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


