Inequalipy contains functions for the Kolm-Pollak, Atkinson and Gini Index aproaches to calculating inequality of a distribution
Project description
Inequalipy
Github Link
Python Pip Link
GitHub Link for R version
Inequalipy contains functions for the calculating the inequality of a distribution:
- Kolm-Pollak Equally-Distributed Equivalent (EDE) and Index
- Atkinson EDE and Index
- Gini Index
The Atkinson and Gini approaches are traditionally used for evaluating the inequality of income distribution. The Kolm-Pollak has recently been modified so that it is suitable for quantities that are undesirable, e.g., exposure to health risks or environmental burdens. This means it is suitable for use in urban planning contexts.
The Kolm-Pollak functions are also separable, meaning they can be used to evaluate
subgroups and thus evaluate the inequity of the distribution.
When using this code, please cite the following two papers:
- Sheriff, G., & Maguire, K. B. (2020). Health Risk, Inequality Indexes, and Environmental Justice. Risk Analysis: An Official Publication of the Society for Risk Analysis. https://doi.org/10.1111/risa.13562
- Logan, T. M., Anderson, M. J., Williams, T. G., & Conrow, L. (2021). Measuring inequalities in urban systems: An approach for evaluating the distribution of amenities and burdens. Computers, Environment and Urban Systems, 86, 101590. https://doi.org/10.1016/j.compenvurbsys.2020.101590
This library contains the following functions:
kolmpollak.ede(a, epsilon, kappa, weights)
for calculating the Kolm-Pollak equally-distributed equivalent (EDE)kolmpollak.index(a, epsilon, kappa, weights)
for calculating the Kolm-Pollak inequality indexatkinson.ede(a, epsilon, weights)
for calculating the Atkinson equally-distributed equivalentatkinson.index(a, epsilon, weights)
for calculating the Atkinson inequality indexgini(a, weights)
for calculating the Gini index
Usage
Installation
pip install inequalipy
Usage
Import the package and call the required function:
import inequalipy as ineq
ineq.kolmpollak.ede(a, epsilon, weights)
ineq.gini(a)
Alternatively, you may import all of the packages:
from inequalipy import *
gini(a)
atkinson.index(a)
Examples
Check out example.ipynb for examples or https://github.com/MitchellAnderson112/access_inequality_index for the function applied in a non-trivial context.
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
Built Distribution
Hashes for inequalipy-1.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b24e096e6cd33c5286654c2e534f0d87d39eb205f9582c529d7efb030d16ad8 |
|
MD5 | b975ba24c318dc1b60eb85886eb74270 |
|
BLAKE2b-256 | 55a73b0c22615d3d9aa43dd630ee8e31b2bb75001fac16ad2d6316a095aaf7ee |