Skip to main content

An open-source Python package for calculating and organizing sectoral flows and interdependencies

Project description

build codecov Binder status

interflow

interflow is an open-source Python package for collecting, calculating, organizing, and visualizing cross-sectoral resource interdependencies and flows.

Purpose

interflow provides a flexible, adaptable, and updatable method to evaluate the interdependencies between sectors and across regions for multiple resource types. The interdependencies and relationships between sectors offer multi-faceted and multi-scale opportunities as well as vulnerabilities. Whether it is water, energy, or otherwise, resources pass from source to discharge by flowing through sectors and are oftentimes a critical component of a sector's functionality.

The interflow package was created to:

  • Provide a framework to aggregate and organize known resource flows through various sectors within a region
  • Calculate and build additional flows between sectors in alternative units based on interdependency intensity values
  • Provide data output and visualizations in a format that can be used to answer questions about cross-sectoral dependencies, how resources flow through sectors in an individual region, and how these dependencies compare across regions.

fig

Though the package comes equipped with sample data for water and energy values across multiple sectors at the US county level, the interflow package can be used for any region, set of regions, set of sectors, and resource type so long as the appropriate data is provided by the user.

For more information on how the interflow package works, how to generalize it with your own data, see the documentation.

Installation

interflow can be installed via pip by running the following from a terminal window:

pip install interflow

Quickstarter

See interflow in action with our Quickstarter Jupyter Notebook hosted on binder!

User Guide

If you're interested in background information and explanations on how the model works visit out User Guide

Contributing to interflow

Spotted a bug or have a suggestion to improve the model? We'd love your input! See our guidelines for contributing.

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

interflow-1.0.3.tar.gz (27.9 MB view details)

Uploaded Source

File details

Details for the file interflow-1.0.3.tar.gz.

File metadata

  • Download URL: interflow-1.0.3.tar.gz
  • Upload date:
  • Size: 27.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.26.0 requests-toolbelt/0.9.1 urllib3/1.26.7 tqdm/4.63.1 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.4

File hashes

Hashes for interflow-1.0.3.tar.gz
Algorithm Hash digest
SHA256 be6f2f095495a41292cc4215ca6bd2540fe9b4c70ff49c699542e9e5f3a553d9
MD5 7d7b78a72604e33eee92b118d54cc0ac
BLAKE2b-256 b7a6234642855c56dac171fc57b9c2efc25fccae06b16d2e31ed8ff8264a3367

See more details on using hashes here.

Supported by

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