From b9966f33d6d6ca4dda1ed5f646a6cb0f0bcebe58 Mon Sep 17 00:00:00 2001 From: Paul Waddell Date: Fri, 21 Aug 2026 12:01:17 +0200 Subject: [PATCH] Document project scope and status --- README.rst | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index a4c8544..7a6a6c2 100644 --- a/README.rst +++ b/README.rst @@ -7,6 +7,33 @@ Tools for the extraction of OpenStreetMap (OSM) street network data. Intended to be used in tandem with Pandana and UrbanAccess libraries to extract street network nodes and edges. +Project scope and status +------------------------ + +**Status:** Deprecated / Migration + +**Mission:** OSMnet provides the legacy OpenStreetMap network-acquisition +functionality used by existing Pandana and UrbanAccess workflows while those +projects migrate to maintained OSM libraries. + +The project is retained to support: + +* existing Pandana and UrbanAccess integrations; +* compatibility needed during the migration period; +* documentation of established OSMnet workflows; and +* orderly transition of downstream users. + +New applications should use actively maintained OSM libraries such as OSMnx +or Pyrosm for OpenStreetMap network acquisition. + +OSMnet will be archived after dependent UDST projects no longer require it. +Development during the migration period is limited primarily to critical +compatibility and migration support. + +See the `UDST Project Directory +`__ for +organization-wide project status and policy. + Overview ======== @@ -93,4 +120,4 @@ Related UDST libraries :target: https://ci.appveyor.com/project/pksohn/osmnet .. |Coverage Status| image:: https://coveralls.io/repos/github/UDST/osmnet/badge.svg?branch=master - :target: https://coveralls.io/github/UDST/osmnet?branch=master \ No newline at end of file + :target: https://coveralls.io/github/UDST/osmnet?branch=master