diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 650d76e..e3a301b 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -85,4 +85,10 @@ jobs: - name: "Run tests ${{ matrix.submodule.name }}" run: | - pytest ${{ matrix.submodule.pytest_args }} + pytest ${{ matrix.submodule.pytest_args }} --cov --cov-branch --cov-report=xml + + - name: Upload results to Codecov + uses: codecov/codecov-action@v5 + with: + token: ${{ secrets.CODECOV_TOKEN }} + slug: BikeNetKit/FixBikeNet \ No newline at end of file diff --git a/README.md b/README.md index 0bceb76..6a5d4c9 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,19 @@ # Bike Net Kit / Fix Bike Net +[![PyPI Version](https://img.shields.io/pypi/v/fixbikenet?color=10d249)](https://pypi.org/project/FixBikeNet/) [![Docs](https://github.com/BikeNetKit/FixBikeNet/actions/workflows/docs.yml/badge.svg)](https://bikenetkit.github.io/FixBikeNet/) [![Test](https://github.com/BikeNetKit/FixBikeNet/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/BikeNetKit/FixBikeNet/actions/workflows/test.yml) -[![PyPI - Version](https://img.shields.io/pypi/v/fixbikenet)](https://pypi.org/project/FixBikeNet/) -[![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) -![Human created](https://raw.githubusercontent.com/BikeNetKit/.github/refs/heads/main/profile/_static/badge_humancreated.svg) +[![Code coverage](https://codecov.io/gh/BikeNetKit/FixBikeNet/graph/badge.svg)](https://codecov.io/gh/BikeNetKit/FixBikeNet) -The Python package `fixbikenet` identifies the most important gaps to fill in a city's bicycle network. - -The software downloads and pre-processes data from OpenStreetMap, identifies the gaps, saves the results, creates plots and videos. The source code builds on [the code from the research paper](https://github.com/anastassiavybornova/bikenwgaps) _Automated Detection of Missing Links in Bicycle Networks_. - - -**Publication**: [https://doi.org/10.1111/gean.12324](https://doi.org/10.1111/gean.12324) +The Python package `fixbikenet` identifies the most important gaps to fill in a city's bicycle network. You can download street and bike network data with a single line of code, simulate different bicycle network fixing scenarios, and export and plot the resulting prioritized gaps. +FixBikeNet is a decision support tool for urban planners. It is also useful for proactive citizens to help inform their city about data-driven improvements, and it aims to foster research on bicycle networks. ## Installation ### The easy way -The currently default way to install FixBikeNet is using pip: +The currently recommended way to install FixBikeNet is using pip: ``` pip install fixbikenet @@ -33,10 +28,10 @@ The best way to install FixBikeNet is using [`conda`](https://docs.conda.io/proj conda install -c conda-forge fixbikenet ``` --> -If this does not work, consult our [installation docs](https://bikenetkit.github.io/FixBikeNet/installation/). +If this does not work, consult our [installation docs](https://docs.bikenetkit.org/FixBikeNet/installation/). ### Advanced and development installations - See our [installation docs](https://bikenetkit.github.io/FixBikeNet/installation/) for details. + See our [installation docs](https://docs.bikenetkit.org/FixBikeNet/installation/) for details. ## Usage @@ -46,11 +41,22 @@ We provide a minimum working example in two formats: - Jupyter notebook ([examples/mwe.ipynb](examples/mwe.ipynb)) ## Docs -Find more information in our docs: [https://bikenetkit.github.io/FixBikeNet/](https://bikenetkit.github.io/FixBikeNet/) +Find more information in our docs: [https://docs.bikenetkit.org/FixBikeNet/](https://docs.bikenetkit.org/FixBikeNet/) + +## Source +The source code builds on [the code from the research paper](https://github.com/anastassiavybornova/bikenwgaps) _Automated Detection of Missing Links in Bicycle Networks_. + +**Publication**: [https://doi.org/10.1111/gean.12324](https://doi.org/10.1111/gean.12324) + + +## How to cite +If you use FixBikeNet in your research, please cite the paper: +> A. Vybornova, T. Cunha, A. Gühnemann, M. Szell. Automated Detection of Missing Links in Bicycle Networks. Geographical Analysis 55(2), 239-267 (2023) +> DOI: [10.1111/gean.12324](https://doi.org/10.1111/gean.12324) ## Supported by -Development of BikeNetKit/FixBikeNet was supported by the [Innovation Fund Denmark](https://innovationsfonden.dk/en) and the EU HORIZON project [JUST STREETS](https://www.just-streets.eu). +Development of BikeNetKit/FixBikeNet 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)    [![European Union](https://raw.githubusercontent.com/BikeNetKit/.github/refs/heads/main/profile/_static/logo_eu.png)](https://commission.europa.eu/index_en)   [![JUST STREETS](https://raw.githubusercontent.com/BikeNetKit/.github/refs/heads/main/profile/_static/logo_juststreets.png)](https://www.just-streets.eu/) diff --git a/environment-dev.yml b/environment-dev.yml index 983925e..f06441c 100644 --- a/environment-dev.yml +++ b/environment-dev.yml @@ -12,6 +12,7 @@ dependencies: - osmnx>=1.9.4 - pip - pytest + - pytest-cov - pixi-pycharm - pre-commit - sphinx