diff --git a/README.md b/README.md index 6a5d4c9..bfb7ccd 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Bike Net Kit / Fix Bike Net +# FixBikeNet [![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/) @@ -9,6 +9,11 @@ The Python package `fixbikenet` identifies the most important gaps to fill in a 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. +## When to use +FixBikeNet works well for cities or areas that have a well developed -but not yet perfect- bicycle network. Recommended example cities to fix: Aalborg, Amsterdam, Copenhagen + +For alternative approaches, or for cities with less developed bicycle networks, consider using [LinkBikeNet](https://github.com/BikeNetKit/LinkBikeNet) or extending the existing network with [GrowBikeNet](https://github.com/BikeNetKit/GrowBikeNet). + ## Installation ### The easy way diff --git a/docs/source/_static/favicon.png b/docs/source/_static/favicon.png new file mode 100644 index 0000000..064924c Binary files /dev/null and b/docs/source/_static/favicon.png differ diff --git a/docs/source/_static/logo_fixbikenet.png b/docs/source/_static/logo_fixbikenet.png new file mode 100644 index 0000000..9606c18 Binary files /dev/null and b/docs/source/_static/logo_fixbikenet.png differ diff --git a/docs/source/_static/logo_fixbikenet.svg b/docs/source/_static/logo_fixbikenet.svg new file mode 100644 index 0000000..1bd1de6 --- /dev/null +++ b/docs/source/_static/logo_fixbikenet.svg @@ -0,0 +1,6 @@ + + + + + + diff --git a/docs/source/conf.py b/docs/source/conf.py index ce0e6fb..a3b374f 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -61,12 +61,15 @@ ### select html theme html_theme = "furo" +html_logo = "_static/logo_fixbikenet.svg" +html_favicon = "_static/favicon.png" html_theme_options = { - "pygment_light_style": "tango", - "logo": { - "image_light": "logo.png", - "image_dark": "logo.png", - }, + "sidebar_hide_name": True, + "source_repository": "https://github.com/BikeNetKit/FixBikeNet/", + "source_branch": "main", + "source_directory": "docs/source/", + "top_of_page_buttons": ["view", "edit"], + "navigation_with_keys": True, "light_css_variables": { "color-brand-primary": "#096a51", "color-brand-content": "#096a51", diff --git a/docs/source/index.rst b/docs/source/index.rst index 2b000cd..d3258a1 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -6,11 +6,16 @@ FixBikeNet |version| documentation =================================== -The Python package ``fixbikenet`` identifies the most important gaps to fill in a city's bicycle network. It is hosted on `Github `__, part of `BikeNetKit `__. +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. It is hosted on `Github `__, part of `BikeNetKit `__. -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 `__ *Automated Detection of Missing Links in Bicycle Networks*. +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. + +When to use +----------- + +FixBikeNet works well for cities or areas that have a well developed -but not yet perfect- bicycle network. Recommended example cities to fix: Aalborg, Amsterdam, Copenhagen +For alternative approaches, or for cities with less developed bicycle networks, consider using `LinkBikeNet `__ or extending the existing network with `GrowBikeNet `__. Setup and use ------------- @@ -24,6 +29,12 @@ is a good place to start, which also explains how the package works in detail. F .. TBA +Source +------ + +The source code builds on `the code from the +research paper `__ *Automated Detection of Missing Links in Bicycle Networks*. + How to cite -----------