Metadata-Version: 2.4
Name: simcenter-pyncoda-fork
Version: 3.0.0.post2
Summary: A Python package for generating probabilistic household and population data for community resilience analysis
Author: Nathanael Rosenheim
License: Mozilla Public License Version 2.0
        ==================================
        
        1. Definitions
        --------------
        
        1.1. "Contributor"
            means each individual or legal entity that creates, contributes to
            the creation of, or owns Covered Software.
        
        1.2. "Contributor Version"
            means the combination of the Contributions of others (if any) used
            by a Contributor and that particular Contributor's Contribution.
        
        1.3. "Contribution"
            means Covered Software of a Contributor.
        
        1.4. "Covered Software"
            means Source Code Form to which the initial Contributor has attached
            the notice in Exhibit A, the Executable Form of such Source Code
            Form, and Modifications of such Source Code Form, in each case
            including portions thereof.
        
        1.5. "Incompatible With Secondary Licenses"
            means
            (a) that the initial Contributor has attached the notice described
                in Exhibit B to the Covered Software; or
            (b) that the Covered Software was obtained under the terms of version
                1.1 or earlier of the License, but not also under the terms of a
                Secondary License.
        
        1.6. "Executable Form"
            means any form of the work other than Source Code Form.
        
        1.7. "Larger Work"
            means a work that combines Covered Software with other material, in
            a separate file or files, that is not Covered Software.
        
        1.8. "License"
            means this document.
        
        1.9. "Licensable"
            means having the right to grant, to the maximum extent possible,
            whether at the time of the initial grant or subsequently, any
        Next    all of the rights conveyed by this License.
        
        1.10. "Modifications"
            means any of the following:
            (a) any file in Source Code Form that results from an addition to,
                deletion from, or modification of the contents of Covered
                Software; or
            (b) any new file in Source Code Form that contains any part of
                Covered Software.
        
        1.11. "Patent Claims" of a Contributor
            means any patent claim(s), including without limitation, method,
            process, and apparatus claims, in any patent Licensable by such
            Contributor that would be infringed by making, using, selling,
            offering for sale, importing or otherwise transferring the Covered
            Software or individual components thereof, either alone or combined
            with other code, badged in any manner.
        
        1.12. "Secondary License"
            means either the GNU General Public License, Version 2.0, the GNU
            Lesser General Public License, Version 2.1, the GNU Affero General
            Public License, Version 3.0, or any later versions of those
            licenses.
        
        1.13. "Source Code Form"
            means the form of the work preferred for making modifications.
        
        1.14. "You" (or "Your")
            means an individual or a legal entity exercising rights under this
            License. For legal entities, "You" includes any entity that
            controls, is controlled by, or is under common control with You. For
            purposes of this definition, "control" means (a) the power, direct
            or indirect, to cause the direction or management of such entity,
            whether by contract or otherwise, or (b) ownership of more than
            fifty percent (50%) of the outstanding shares or beneficial
            ownership of such entity.
        
        2. License Grant and Conditions
        ------------------------------
        
        2.1. Grants
        
        Each Contributor hereby grants You a world-wide, royalty-free,
        non-exclusive license:
        
        (a) under intellectual property rights (other than patent or trademark)
            Licensable by such Contributor to use, reproduce, make available,
            modify, display, perform, distribute, and otherwise exploit its
            Contributions, either on their own or as part of modifications.
        
        (b) under Patent Claims of such Contributor to make, use, sell, offer
            for sale, import, and otherwise transfer either its Contributions
            or its ContributorVersion.
        
        2.2. Effective Date
        
        The licenses granted in Section 2.1 with respect to any Contribution
        become effective for each Contribution on the date the Contributor first
        distributes such Contribution.
        
        2.3. Limitations on Grant Scope
        
        The licenses granted in this Section 2 are the only rights granted under
        this License. No additional rights or licenses will be implied from the
        distribution or licensing of Covered Software under this License.
        Notwithstanding Section 2.1(b) above, no patent license is granted
        under this License:
        
        (a) for any code that a Contributor has removed from Covered Software;
            or
        
        (b) for infringements caused by: (i) Your modifications of Covered
            Software, or (ii) the combination of Covered Software with other
            software or devices.
        
        2.4. Fair Use
        
        This License is not intended to limit any rights You have under
        applicable copyright doctrines of fair use, fair dealing, or other
        equivalents.
        
        2.5. Conditions
        
        Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
        in Section 2.1.
        
        3. Responsibilities
        -------------------
        
        3.1. Distribution of Source Form
        
        All distribution of Covered Software in Source Code Form, including
        modifications that You create or to which You contribute, must be under
        the terms of this License. You must inform recipients that the Source
        Code Form of the Covered Software is governed by the terms of this
        License, and how they can obtain a copy of this License. You may not
        attempt to alter or restrict the recipients' rights in the Source Code
        Form.
        
        3.2. Distribution of Executable Form
        
        If You distribute Covered Software in Executable Form, You must also
        make the Source Code Form of the Covered Software available, as described
        in Section 3.1, and You must inform recipients of the Executable Form
        how they can obtain a copy of the Source Code Form.
        
        3.3. Distribution of a Larger Work
        
        You may create and distribute a Larger Work under terms of Your choice,
        provided that You also comply with the requirements of this License for
        the Covered Software. If the Larger Work is a combination of Covered
        Software with a work governed by one or more Secondary Licenses, and the
        Coveraction of Covered Software is not Incompatible With Secondary
        Licenses, this License permits You to additionally distribute such
        Covered Software under the terms of such Secondary License(s), so that
        the recipient of the Larger Work may, at their option, further
        distribute the Covered Software under the terms of either this License
        or such Secondary License(s).
        
        3.4. Notices
        
        You may not remove or alter the substance of any license notices
        (including copyright notices, patent notices, disclaimers of warranty,
        or limitations of liability) contained within the Source Code Form of
        the Covered Software, except that You may alter any license notices to
        the extent required to remedy known factual inaccuracies.
        
        3.5. Application of Additional Terms
        
        You may choose to offer, and to charge a fee for, warranty, support,
        indemnity or liability obligations to one or more recipients of Covered
        Software. However, You may do so only on Your own behalf, and not on
        behalf of any Contributor. You must make it clear that any such
        warranty, support, indemnity, or liability obligation is offered by You
        alone, and You hereby agree to indemnify every Contributor for any
        liability incurred by such Contributor as a result of warranty, support,
        indemnity or liability terms You offer. You may include additional
        disclaimers of warranty and limitations of liability specific to any
        jurisdiction.
        
        4. Inability to Comply Due to Statute or Regulation
        -------------------------------------------------
        
        If it is impossible for You to comply with any of the terms of this
        License with respect to some or all of the Covered Software due to
        statute, judicial order, or regulation, then You must: (a) comply with
        the terms of this License to the maximum extent possible; and (b)
        describe the limitations and the code they affect. Such description
        must be placed in a text file included with all distributions of the
        Covered Software under this License. Except to the extent prohibited by
        statute or regulation, such description must be sufficiently detailed
        for a recipient of ordinary skill to be able to understand it.
        
        5. Termination
        -------------
        
        5.1. The rights granted under this License will terminate automatically
        if You fail to comply with any of its terms. However, if You come into
        compliance, then the rights granted under this License from a
        particular Contributor are reinstated (a) provisionally, unless and
        until such Contributor explicitly and finally terminates Your grants,
        and (b) permanently, if such Contributor fails to notify You of the
        non-compliance by some reasonable means prior to 60 days after You have
        come into compliance. Moreover, Your grants under this License from a
        particular Contributor are reinstated permanently if such Contributor
        notifies You of the non-compliance by some reasonable means, this is the
        first time You have received notice of non-compliance with this License
        from such Contributor, and You come into compliance prior to 30 days
        after Your receipt of the notice.
        
        5.2. If You initiate litigation against any entity by asserting a patent
        infringement claim (excluding declaratory judgment actions,
        counter-claims, and cross-claims) alleging that a Contributor Version
        directly or indirectly infringes any patent, then the rights granted to
        You by all Contributors for the Covered Software under Section 2.1 of
        this License shall terminate.
        
        5.3. In the event of termination under Sections 5.1 or 5.2 above, all
        rights granted to You under this License shall terminate. Sections 1,
        2.3, 2.4, 2.5, 3.4, 3.5, 4, 5, 6, 7, 8, and 9 will survive any
        termination of this License.
        
        6. Disclaimer of Warranty
        -------------------------
        
        Covered Software is provided under this License on an "as is" basis,
        without warranty of any kind, either expressed, implied, or statutory,
        including, without limitation, warranties that the Covered Software is
        free of defects, merchantable, fit for a particular purpose or
        non-infringing. The entire risk as to the quality and performance of
        the Covered Software is with You. Should any Covered Software prove
        defective in any respect, You (not any Contributor) assume the cost of
        any necessary servicing, repair, or correction. This disclaimer of
        warranty constitutes an essential part of this License. No use of any
        Covered Software is authorized under this License except under this
        disclaimer.
        
        7. Limitation of Liability
        --------------------------
        
        Under no circumstances and under no legal theory, whether tort
        (including negligence), contract, or otherwise, shall any Contributor,
        or anyone else who distributes Covered Software as permitted above, be
        liable to You for any direct, indirect, special, incidental, or
        consequential damages of any character including, without limitation,
        damages for loss of goodwill, work stoppage, computer failure or
        malfunction, or any and all other commercial damages or losses, even if
        such party shall have been informed of the possibility of such damages.
        This limitation of liability shall not apply to liability for death or
        personal injury resulting from such party's negligence to the extent
        applicable law prohibits such limitation. Some jurisdictions do not
        allow the exclusion or limitation of incidental or consequential
        damages, so this exclusion and limitation may not apply to You.
        
        8. Litigation
        -------------
        
        Any litigation relating to this License may be brought only in the
        courts of a jurisdiction where the defendant maintains its principal
        place of business or, if the defendant is an individual, where the
        defendant resides, and each party consents to the jurisdiction of such
        courts, provided that nothing herein shall prevent either party from
        bringing an action to enforce a judgment or order of such courts in
        any other jurisdiction.
        
        9. Miscellaneous
        ----------------
        
        This License represents the complete agreement concerning the subject
        matter hereof. If any provision of this License is held to be
        unenforceable, such provision shall be reformed only to the extent
        necessary to make it enforceable. Any law or regulation which provides
        that the language of a contract shall be construed against the drafter
        shall not be used to construe this License against a Contributor.
        
        10. Versions of the License
        ---------------------------
        
        10.1. New Versions
        
        Mozilla Foundation is the license steward. Except as provided in Section
        10.3, no one other than the license steward has the right to modify or
        publish new versions of this License. Each version will be given a
        distinguishing version number.
        
        10.2. Effect of New Versions
        
        You may distribute the Covered Software under the terms of the version
        of the License under which You originally received the Covered Software,
        or under the terms of anyC-version of the License published by the
        license steward.
        
        10.3. Modified Versions
        
        If you create software not governed by this License, and you want to
        create a new license for such software, you may create and use a
        modified version of this License if you rename the license and remove
        any references to the name of the license steward (except to note that
        the modified license differs from this License).
        
        10.4. Distributing Source Code Form that is Incompatible With Secondary
        Licenses
        
        If You choose to distribute Source Code Form that is Incompatible With
        Secondary Licenses, You may not include a notice described in Exhibit B
        in Your distribution. If You choose to distribute Source Code Form that
        is compatible with Secondary Licenses, You may include a notice
        described in Exhibit B in Your distribution, and You may simultaneously
        distribute the Covered Software under a Secondary License, as described
        in Section 3.3.
        
        Exhibit A - Source Code Form License Notice
        -------------------------------------------
        
          This Source Code Form is subject to the
          terms of the Mozilla Public License, v.
          2.0. If a copy of the MPL was not
          distributed with this file, You can
          obtain one at https://mozilla.org/MPL/2.0/.
        
        Exhibit B - "Incompatible With Secondary Licenses" Notice
        ---------------------------------------------------------
        
          This Source Code Form is "Incompatible
          With Secondary Licenses", as defined by
          the Mozilla Public License, v. 2.0.
Project-URL: Homepage, https://github.com/npr99/intersect-community-data
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: GIS
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.26.4
Requires-Dist: pandas>=2.2.2
Requires-Dist: scipy>=1.13.1
Requires-Dist: scikit-learn>=1.4.2
Requires-Dist: geopandas>=0.14.2
Requires-Dist: shapely>=2.0.1
Requires-Dist: fiona>=1.9.5
Requires-Dist: pyproj>=3.6.1
Requires-Dist: rasterio>=1.3.10
Requires-Dist: geopy>=2.4.1
Requires-Dist: geographiclib>=2.0
Requires-Dist: affine>=2.4.0
Requires-Dist: mercantile>=1.2.1
Requires-Dist: snuggs>=1.4.7
Requires-Dist: matplotlib>=3.8.4
Requires-Dist: seaborn>=0.13.2
Requires-Dist: folium>=0.14.0
Requires-Dist: contextily>=1.6.0
Requires-Dist: requests>=2.32.2
Requires-Dist: wget>=3.2
Requires-Dist: fpdf2>=2.7.9
Requires-Dist: ipywidgets>=8.1.2
Requires-Dist: IPython
Requires-Dist: scooby>=0.10.0
Provides-Extra: incore
Requires-Dist: pyincore; extra == "incore"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: jupyter; extra == "dev"
Requires-Dist: notebook; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Dynamic: license-file

[![DOI](https://zenodo.org/badge/478737101.svg)](https://zenodo.org/badge/latestdoi/478737101)

# Repository Title: Intersect Community Data (pyncoda)

## Description 
People are the most important part of community resilience planning. However, models for community resilience planning tend to focus on buildings and infrastructure. This repository provides a solution that connects people to buildings for community resilience models. The housing unit inventory method transforms aggregated population data into disaggregated housing unit data that includes occupied and vacant housing unit characteristics. Detailed household characteristics include size, race, ethnicity, income, group quarters type, vacancy type and census block. Applications use the housing unit allocation method to assign the housing unit inventory to structures within each census block through a reproducible and randomized process. The benefits of the housing unit inventory include community resilience statistics that intersect detailed population characteristics with hazard impacts on infrastructure; uncertainty propagation; and a means to identify gaps in infrastructure data such as limited building data. This repository includes all of the python code files. Python is an open source programming language and the code files provide future users with the tools to generate a 2010 housing unit inventory for any county in the United States. Applications of the method are reproducible in IN-CORE (Interdependent Networked Community Resilience Modeling Environment).

## License

**Output Data License**: Open Data Commons Attribution License (https://opendatacommons.org/licenses/by/summary/)

**Program Code**: Mozilla Public License Version 2.0 (https://www.mozilla.org/en-US/MPL/2.0/)

## Setup Environment 
1. [Install Anaconda](https://www.anaconda.com/products/individual)
2. Install VS Code
3. Download Repository
4. See `environment.yml` file for dependencies
5. Run the primary Jupyter Notebook in the main folder

## More Details
For more details on the following refer to the [Admin Folder](https://github.com/npr99/intersect-community-data/tree/main/Admin)
- [Acknowledgements](https://github.com/npr99/intersect-community-data/blob/main/Admin/ncoda_Acknowledgements.md)
- [Census Data Terms of Use](https://github.com/npr99/intersect-community-data/blob/main/Admin/ncoda_CensusDataTermsofUse.md)
- [Directory Design](https://github.com/npr99/intersect-community-data/blob/main/Admin/ncoda_DirectoryDesign.md)
- [File Name Plan](https://github.com/npr99/intersect-community-data/blob/main/Admin/ncoda_FileNamePlan.md)
- [Funding Sources](https://github.com/npr99/intersect-community-data/blob/main/Admin/ncoda_Funding.md)
- [Related Works](https://github.com/npr99/intersect-community-data/blob/main/Admin/ncoda_Funding.md)



