qolimpervious


Nameqolimpervious JSON
Version 1.5 PyPI version JSON
download
home_pagehttps://github.com/ProvidenceAdu/qolimpervious
SummaryThis library executes impervious surface analysis for the Quality of Life Exporer dashboard
upload_time2024-07-19 07:12:03
maintainerNone
docs_urlNone
authorProvidence Adu,Ph.D.
requires_pythonNone
licenseNone
keywords urban institute python mecklenburg county quality of life explorer impervious npa
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
# Impervious Surface Analysis

This package provides a Python class `impervious` tailored for analyzing impervious surface using ArcPy. The class is designed for Urban Institute's Quality of Life (QOL) variables.

## Installation

Install `qolimpervious` from PyPI using pip:


pip install qolimpervious

# Usage

import `pandas` as `pd`

import `arcpy`

import `qolimpervious` as `qi`

I = qi.impervious('Singlefamily_Impervious_2023','Commercial_Impervious_2023','Impervious2023')

I.intersect('NPA2023','IntersectImpervious2023')

I.exportcsv(path,'QOL_04_2023.csv')


# Methods

impervious

This class executes impervious surface analysis for Urban Institute's QOL Variables.

`__init__(self, residential, commercial, UnionOutputname)`

- residential: The residential landuse featureclass.

- commercial: The commercial landuse featureclass.

- UnionOutputname: Name of output featureclass for the union analysis.

`union(self)`

Unions the residential and commercial feature classes used for computing the total impervious surface in the city.

`dissovle(self)`

Adds a field to the Union feature class, calculates the field as 0, and dissolves the Union Feature class using the added field.

`intersect(self, NPAFeatureclass, IntersectOutput)`

NPAFeatureclass: The NPA feature class.

IntersectOutput: The output name for the intersect analysis.

Performs the intersect analysis and calculates the area of intersected features.

`exportcsv(self, OutputDirectory, Filename)`

- OutputDirectory: The directory where the CSV file will be exported.

- Filename: The name of the CSV file.

- Exports the results of the impervious surface analysis as a CSV file.

License

This project is licensed under the MIT License - see the LICENSE file for details.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ProvidenceAdu/qolimpervious",
    "name": "qolimpervious",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "urban institute, python, Mecklenburg County, quality of life explorer, impervious, NPA",
    "author": "Providence Adu,Ph.D.",
    "author_email": "<padu@charlotte.edu>",
    "download_url": "https://files.pythonhosted.org/packages/32/ce/d2f6d20a17fda5bd1c974ea54d9aa477cc8c9c5f4e1479a5b97a6de998cb/qolimpervious-1.5.tar.gz",
    "platform": null,
    "description": "\r\n# Impervious Surface Analysis\r\n\r\nThis package provides a Python class `impervious` tailored for analyzing impervious surface using ArcPy. The class is designed for Urban Institute's Quality of Life (QOL) variables.\r\n\r\n## Installation\r\n\r\nInstall `qolimpervious` from PyPI using pip:\r\n\r\n\r\npip install qolimpervious\r\n\r\n# Usage\r\n\r\nimport `pandas` as `pd`\r\n\r\nimport `arcpy`\r\n\r\nimport `qolimpervious` as `qi`\r\n\r\nI = qi.impervious('Singlefamily_Impervious_2023','Commercial_Impervious_2023','Impervious2023')\r\n\r\nI.intersect('NPA2023','IntersectImpervious2023')\r\n\r\nI.exportcsv(path,'QOL_04_2023.csv')\r\n\r\n\r\n# Methods\r\n\r\nimpervious\r\n\r\nThis class executes impervious surface analysis for Urban Institute's QOL Variables.\r\n\r\n`__init__(self, residential, commercial, UnionOutputname)`\r\n\r\n- residential: The residential landuse featureclass.\r\n\r\n- commercial: The commercial landuse featureclass.\r\n\r\n- UnionOutputname: Name of output featureclass for the union analysis.\r\n\r\n`union(self)`\r\n\r\nUnions the residential and commercial feature classes used for computing the total impervious surface in the city.\r\n\r\n`dissovle(self)`\r\n\r\nAdds a field to the Union feature class, calculates the field as 0, and dissolves the Union Feature class using the added field.\r\n\r\n`intersect(self, NPAFeatureclass, IntersectOutput)`\r\n\r\nNPAFeatureclass: The NPA feature class.\r\n\r\nIntersectOutput: The output name for the intersect analysis.\r\n\r\nPerforms the intersect analysis and calculates the area of intersected features.\r\n\r\n`exportcsv(self, OutputDirectory, Filename)`\r\n\r\n- OutputDirectory: The directory where the CSV file will be exported.\r\n\r\n- Filename: The name of the CSV file.\r\n\r\n- Exports the results of the impervious surface analysis as a CSV file.\r\n\r\nLicense\r\n\r\nThis project is licensed under the MIT License - see the LICENSE file for details.\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "This library executes impervious surface analysis for the Quality of Life Exporer dashboard",
    "version": "1.5",
    "project_urls": {
        "Homepage": "https://github.com/ProvidenceAdu/qolimpervious"
    },
    "split_keywords": [
        "urban institute",
        " python",
        " mecklenburg county",
        " quality of life explorer",
        " impervious",
        " npa"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "22700017b4f23da2330971a8202f427a85126bfb113a3f1bc39fb5d532f95b66",
                "md5": "fd204ce3abef1ac5d780ba69f2bb4cac",
                "sha256": "e18b06ad175bc26298fc09cef9e1e8ab4f44d9772277cd2b79c8055d48ee2279"
            },
            "downloads": -1,
            "filename": "qolimpervious-1.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fd204ce3abef1ac5d780ba69f2bb4cac",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 5112,
            "upload_time": "2024-07-19T07:12:01",
            "upload_time_iso_8601": "2024-07-19T07:12:01.769355Z",
            "url": "https://files.pythonhosted.org/packages/22/70/0017b4f23da2330971a8202f427a85126bfb113a3f1bc39fb5d532f95b66/qolimpervious-1.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "32ced2f6d20a17fda5bd1c974ea54d9aa477cc8c9c5f4e1479a5b97a6de998cb",
                "md5": "b528faf9bac58e3867605f727990ad25",
                "sha256": "b8e9bd2196f41693cc310ee9328580a82dc0f26af44ec794bdad9ab3eb4a7b8d"
            },
            "downloads": -1,
            "filename": "qolimpervious-1.5.tar.gz",
            "has_sig": false,
            "md5_digest": "b528faf9bac58e3867605f727990ad25",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 4248,
            "upload_time": "2024-07-19T07:12:03",
            "upload_time_iso_8601": "2024-07-19T07:12:03.348373Z",
            "url": "https://files.pythonhosted.org/packages/32/ce/d2f6d20a17fda5bd1c974ea54d9aa477cc8c9c5f4e1479a5b97a6de998cb/qolimpervious-1.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-19 07:12:03",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ProvidenceAdu",
    "github_project": "qolimpervious",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "qolimpervious"
}
        
Elapsed time: 0.36943s