Giter VIP home page Giter VIP logo

mdp0023 / svinsight Goto Github PK

View Code? Open in Web Editor NEW
4.0 1.0 0.0 81.6 MB

SVInsight: A python package for calculating an exploratory social vulnerability index (SVI).

Home Page: https://mdp0023.github.io/SVInsight/

License: MIT License

Python 92.86% TeX 7.14%
census-data demographics hazards hazards-resilience social-vulnerability svi vulnerability census-block-group census-tract demographics-data

svinsight's Introduction

SVInsight: Social Vulnerability Index Creation

pages-build-deployment Python version PyPI

SVInsight is a python package for calculating an exploratory social vulnerability index. This package calculates SVI using two methods: (1) an iterative factor analysis method and (2) a rank method, both of which have been heavily utilized in scholarly research. This package automates the creation and comparison of indices using U.S. American Community Survey 5-Year Data (ACS5) at the block group or tract level. Users can customize which social, demographic, and economic variables are included in their own custom indices.

This package is a tool to efficiently calculate an exploratory estimate of social vulnerability for a given region. Social vulnerability is an incredibly complex and constantly evolving concept, and researchers, practitioners, and users of this software should always consult relevant peer-reviewed literature and local experts to validate findings.

For user guides, examples, and a more indepth discussion of social vulnerability indices, refer to the documentation.

Gif of time-series for SVI estimates in Travis County, Texas Travis County SVI estimates from 2013 to 2021

Installation:

To quickly install the package, use pip to install via PyPI:

pip install SVInsight

SVInsight can then be imported into python:

>>> from svinsight import SVInsight as svi

Quick Guide:

In its simplest form the SVInsight workflow takes 5 lines of code:

>>> project = svi(project_name, file_path, api_key, geoids)
>>> project.boundaries_data(boundary, year)
>>> project.census_data(boundary, year)
>>> project.configure_variables(config_file)
>>> project.calculate_svi(config_file, boundary, year)

Some typical compute times that can be expected to run the workflow for various locations at the Block Group level can be found below:

Location Compute Time (seconds)
Texas 125.75
New York 120.10
Connecticut 42.25
Los Angeles, CA 65.60
Providence County, RI 27.22
Travis County, TX 26.34

Contributing

We welcome contributions to SVInsight. Please open an issue or a pull request if there is functionality you would like to see or propose. Refer to our contributing guide for more information.

Citing

If you use this package and wish to cite it, please do. We are currently in the process of submitting this work to the Journal of Open Source Software. In the meantime, please refer to recent published work in Frontiers in Water, Hydrology and Earth System Sciences, and The International Journal of Disaster Risk Reduction.

Funding Acknowledgments

This work was supported in part by the National Science Foundation Graduate Research Fellowship (grant no. DGE-1610403), Future Investigators in NASA Earth and Space Science and Technology (NASA FINESST, grant no. 21-EARTH21-0264), Planet Texas 2050, a research grand challenge at the University of Texas at Austin, and the U.S. Department of Energy, Office of Science, Biological and Environmental Research Program’s South-East Texas Urban Integrated Field Laboratory under Award Number DE-SC0023216.

svinsight's People

Contributors

mdp0023 avatar paolapassah2o avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.