Skip to content

Document project scope and status #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
waddell wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Document project scope and status #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
<https://github.com/UDST/.github/blob/main/PROJECTS.md>`__ for
organization-wide project status and policy.

Overview
========

Expand Down Expand Up @@ -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
:target: https://coveralls.io/github/UDST/osmnet?branch=master