Data

Tools

Indexes

Applications

Experiments

Open Source Science

interflow

interflow: A Python package to organize, calculate, and visualize sectoral interdependency flow data - Published in JOSS (2022)

https://github.com/pnnl/interflow

Science Score: 100.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 1 DOI reference(s) in JOSS metadata
  • ✓
    Academic publication links
    Links to: joss.theoj.org
  • ○
    Committers with academic emails
  • ✓
    Institutional organization owner
    Organization pnnl has institutional domain (www.pnnl.gov)
  • ✓
    JOSS paper metadata
    Published in Journal of Open Source Software
Last synced: 6 months ago · JSON representation ·

Repository

A Python package for organizing and calculating cross-sectoral interdependency flow values

Basic Info
Statistics
  • Stars: 3
  • Watchers: 2
  • Forks: 2
  • Open Issues: 0
  • Releases: 3
Created almost 4 years ago · Last pushed over 2 years ago
Metadata Files
Readme Contributing License Citation

README.md

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:

bash 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.

Owner

  • Name: Pacific Northwest National Laboratory (Public)
  • Login: pnnl
  • Kind: organization
  • Email: dev-central@pnnl.gov
  • Location: United States of America

This Org is intended for the hosting of approved released PNNL software repositories for public use and collaboration.

JOSS Publication

interflow: A Python package to organize, calculate, and visualize sectoral interdependency flow data
Published
June 14, 2022
DOI
Volume 7, Issue 74, Page 4336
Authors
Kendall L. Mongird ORCID
Pacific Northwest National Laboratory, Richland, WA, USA
Konstantinos Oikonomou ORCID
Pacific Northwest National Laboratory, Richland, WA, USA
Juliet S. Homer ORCID
Pacific Northwest National Laboratory, Richland, WA, USA
Jennie S. Rice ORCID
Pacific Northwest National Laboratory, Richland, WA, USA
Editor
Frauke Wiese ORCID
Tags
resource interdependencies sankey diagrams flow diagrams
View PDF Review Thread Software Archive

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please use the following citation:"
authors:
- family-names: "Mongird"
  given-names: "Kendall L."
- family-names: "Oikonomou"
  given-names: "Konstantinos"
- family-names: "Homer"
  given-names: "Juliet S."
- family-names: "Rice"
  given-names: "Jennie S."
title: "interflow: a Python package for collecting, calculating, organizing, and visualizing cross-sectoral resource interdependencies and flows."
version: 0.1.0
date-released: 2022-04-01
url: "https://github.com/pnnl/interflow"

GitHub Events

Total
  • Fork event: 1
Last Year
  • Fork event: 1

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 871
  • Total Committers: 2
  • Avg Commits per committer: 435.5
  • Development Distribution Score (DDS): 0.036
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Kendall Mongird 7****d 840
crvernon c****n@g****m 31

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 4
  • Total pull requests: 16
  • Average time to close issues: 6 days
  • Average time to close pull requests: 9 minutes
  • Total issue authors: 2
  • Total pull request authors: 1
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.44
  • Merged pull requests: 13
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • j3r3m1 (3)
  • kmongird (1)
Pull Request Authors
  • kmongird (16)
Top Labels
Issue Labels
documentation (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 10 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 5
  • Total maintainers: 1
pypi.org: interflow

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

  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 10 Last month
Rankings
Dependent packages count: 10.1%
Dependent repos count: 21.6%
Forks count: 22.6%
Average: 23.7%
Stargazers count: 27.8%
Downloads: 36.5%
Maintainers (1)
kmongird
Last synced: 6 months ago

Dependencies

interflow.egg-info/requires.txt pypi
  • build >=0.7.0
  • json5 >=0.9.6
  • numpy >=1.19.4
  • pandas >=1.3.4
  • plotly >=5.5.0
  • setuptools >=58.2.0
  • sphinx >=4.4.0
  • sphinxemoji >=0.2.0
  • twine >=3.8.0
requirements.txt pypi
  • json5 >=0.9.6
  • numpy >=1.21.3
  • pandas >=1.3.4
  • plotly >=5.5.0
setup.py pypi
  • json5 >=0.9.6
  • numpy >=1.19.4
  • pandas >=1.3.4
  • plotly >=5.5.0
.github/workflows/build.yml actions
  • actions/checkout v1 composite
  • actions/setup-python master composite
  • codecov/codecov-action v2 composite
.github/workflows/draft-pdf.yml actions
  • actions/checkout v2 composite
  • actions/upload-artifact v1 composite
  • openjournals/openjournals-draft-action master composite