Skip to content

Commit

Permalink
RC6: Removed pyrosm adn update README Usage section
Browse files Browse the repository at this point in the history
  • Loading branch information
cbueth committed Apr 17, 2024
1 parent ccb43bb commit b6409d7
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 4 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ Source code to `superblockify` an urban street network
---

`superblockify` is a Python package for partitioning an urban street network into
Superblock-like neighborhoods and for visualizing and analyzing the partition results. A Superblock is a set of adjacent urban blocks where vehicular through traffic is prevented or pacified, giving priority to people walking and cycling.
Superblock-like neighborhoods and for visualizing and analyzing the partition results. A
Superblock is a set of adjacent urban blocks where vehicular through traffic is
prevented or pacified, giving priority to people walking and cycling.

## Installation

Expand Down Expand Up @@ -62,7 +64,10 @@ pip install --no-build-isolation --no-deps -e .

## Usage

For a quick start there are example scripts in
For a quick start after installation,
refer to the [usage section](https://nerdsitu.github.io/superblockify/usage/)
in the documentation.
Additionally, there are example scripts in
the [`examples/`](https://github.com/NERDSITU/superblockify/blob/main/scripts/examples/)
folder and
a [minimal working example](https://github.com/NERDSITU/superblockify/blob/main/scripts/examples/mwe.py).
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
project = "superblockify"
copyright = "2023-2024, Carlson Büth"
author = "Carlson Büth"
release = "1.0.0rc5"
release = "1.0.0rc6"

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
Expand Down
2 changes: 1 addition & 1 deletion superblockify/_version.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
"""superblockify package version."""

__version__ = "1.0.0rc5"
__version__ = "1.0.0rc6"

0 comments on commit b6409d7

Please sign in to comment.