Skip to main content

Library for spatio-temporal transactional network analysis

Project description

STTN (spatio-temporal transactional network) is a generic data model to represent networks with spatial and temporal dimensions and a Python library that implements that standard.

Introduction

Multiple real-world processes can be described by a list of transactions that include temporal and spatial dimensions, while transactions themself form a network between entities. Examples include credit card transactions, phone calls, taxi trips, social network interactions, and the list goes on and on. Defining a generic data model to represent these datasets allows to:

  1. Re-use the data retrieval, parser, and network construction logic.

  2. Provide simplified API for network transformations (based on the knowledge of the network structure).

  3. Implement advanced visualization, analysis, and modeling functionality (thanks to the consistent representation of spatial and temporal components).

Installation

The latest library release and required dependencies can be installed from PyPI:

pip install sttn

Getting started

Import one of the included data providers, for example:

from sttn.data.lehd import OriginDestinationEmploymentDataProvider

The latest list of included data providers can be found in the data package. You can use available providers as an example to define your own parser. If the dataset is open we highly encourage you to open a Pull Request and contribute your provider to the community.

Now you can create an instance of the data provider and retrieve the data:

lehd_provider = OriginDestinationEmploymentDataProvider()
ny_lehd = lehd_provider.get_data(state='ny', year=2018)

Some data providers cache downloaded data on the local disk. The first run may take longer to download data from the Internet, while next runs will re-use the previously downloaded copy. The code above retrieves LEHD Origin-Destination Employment Statistics for New York state based on 2018 census. In addition to the origin-destination employment data the command above downloads shape files for census blocks and leverages both datasets to build the network.

Preview of node and edge attributes is helpful to understand the network structure:

ny_lehd.nodes # to see network nodes
ny_lehd.edges # to see network edges (or transactions)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sttn-0.4.0.tar.gz (259.7 kB view details)

Uploaded Source

Built Distribution

sttn-0.4.0-py2.py3-none-any.whl (79.0 kB view details)

Uploaded Python 2Python 3

File details

Details for the file sttn-0.4.0.tar.gz.

File metadata

  • Download URL: sttn-0.4.0.tar.gz
  • Upload date:
  • Size: 259.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for sttn-0.4.0.tar.gz
Algorithm Hash digest
SHA256 65a06b404409112161130dc8e52de56dc20fc3af76da3e7872f0af017b4100dd
MD5 3fd532723126e5ee00aff793b4450f0d
BLAKE2b-256 bb324527ee9da7ca31657ebea7ce1b115d3bb591f3c8d006a1810b500fe63393

See more details on using hashes here.

File details

Details for the file sttn-0.4.0-py2.py3-none-any.whl.

File metadata

  • Download URL: sttn-0.4.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 79.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for sttn-0.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a75a658802acd8e293130e4c3890506e78f152f3cc455f95f71464d16afd25ab
MD5 533566c6e9dc644932825d3ae25de58e
BLAKE2b-256 a31fd3d0c9dd95ef894d99d4958b864ace07c5b2a48f02728a4548ca33b1d9fa

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page