Moves demo notebooks plots into cityseer.plot module

Moves demo notebooks plots into cityseer.plot module.

This is to simplify use of the functions when running notebooks.

Introduces io module

• moves osm related import and conversion functions to the new io module
• creates a new io function for importing open roads data

Fixes continuity edge info reduction

Fixes continuity edge info reduction when simplifying graphs.

Fixes osm sub-module import from tools module.

Fixes osm sub-module import from tools module.

New OSM module

A new OSM module more formally exposes functions for downloading data from OSM. The motivation for this is to provivde automatic graph cleaning routines for OSM data.

The graph cleaning guide has been updated accordingly.

Enables caching of all jitted functions

This release revises the plumbing of the low level jitted functions so that caching can work more reliably once again.

There are no user facing changes to the API.

Re-enables parallelism

• Re-enables parallelism
• Removes structures.TreeMap in favour of raw numpy arrays. This allows the shortest_path_tree function to be cached (when compiled per JIT).

And another major release

Another major release, this time the API has changed fairly substantially to incorporate GeoDataFrame workflows where possible.

The docs and examples are updated accordingly.

• Documentation for v1.x: see documented code per tagged release v1.2.1
• Documentation for v2.x: see documented code per tagged release v2.0.0
• Documentation for v3+: https://cityseer.benchmarkurbanism.com/

Major release: code quality overhaul

This is a major release with some breaking changes.

If you are working with version 1 and are looking for the previous version documentation, see the v1.2.1 tagged release which contains the now deprecated version and its associated docstrings.

The outwards facing API is mostly unaffected, however, certain methods have been renamed to bring them in line with naming conventions, for example, all methods previously named with a leading nX have now been renamed to nx, for example, nX_simple_geoms has been renamed to nx_simple_geoms.

The low level API has been substantially overhaulled to streamline and better organise underlying data structures. User-facing methods are unaffected by this change. Previously, data structures used for nodes and edges were stored in raw numpy arrays with different indices taken to reference different data attributes. This has been replaced with numba jitted classes allowing for explicit attributes to be used. See cityseer.structures for more information about these structures and their attributes.

The code base has been substantially overhauled to include more robust support for typehinting, with formatting, linting, and typechecking now baked-into the CI. The project is now managed with a pyproject.toml file.

Version increment

New version increment to reflect accumulation of minor tweaks.

Jitter scale is now set to zero by default.