ealameda31/msa-mapper

Geocodes locations and maps coordinates to Census MSAs

msa-mapper

Python library which helps users geocode locations and map longitude/latitude coordinates to the Metropolitan Statistical Areas (MSAs) defined by the Census Bureau.

---

Table of Contents

• Requirements
• Installation
• Documentation
• Manual Dependencies
• Contact

Requirements

The Python version used for development is 3.10.4. Below are a series of steps to follow before installation:

1. Create a Python virtual environment where the library can be installed

2. Clone this repository within a computer directory (folder) of your choice (please ensure Git is installed and an SSH key is specified for your profile):

     git clone [email protected]:Ealameda31/msa-mapper.git

3. Initialize Git LFS and pull the files the library needs for certain functions:

     git lfs install
     git lfs pull

Installation

After activating a Python virtual environment, users should navigate to the repository contents (i.e., cd msa-mapper/) and run the following command:

  python setup.py bdist_wheel 

This should create a dist folder within your directory containing the wheel file. Then, the library can be installed within your environment by running the command below:

  pip install dist/*

If users are experiencing issues with geospatial packages, download them from Christoph Gohlke's Binaries. Download and install the wheel file that corresponds to the environment's Python version (i.e., Python 3.10.4 = cp310). Usually problems resolve after manually installing GDAL and Fiona.

Documentation

Library structure, function documentation, and examples to follow can be found on this webpage.

Manual Dependencies

Shapefiles are manually uploaded and are located within the internal directory of the library. These file are stored in Git LFS to avoid unnecessary data downloads. They are updated on an infrequent basis (every 10 years) but finding a way to cross-reference the shapefiles programmatically would be ideal. s

Contact

Feel free to create an issue within this GitHub repository if a bug is found or for additional enhancements. The developers will typically respond within 48 hours.

For additional questions and/or use-cases, please contact Enrique M. Alameda-Basora ([email protected]).

msa-mapper's Issues

Unit test for census_msa module

Add minimal testing to ensure main function in module, map_census_locations(), is working as intended.

mkdocs home page

Explain how the modules function at a rudimentary level

Integration test for library

Add a simple integration test that call main modules of Python library together and only runs if both unit tests pass.

CI/CD for dev branch

• Build Python library through Docker container
• Run testing modules
• Ensure mkdocs site can be built

CI/CD for master branch

• Build Python library through Docker container (PR is made/merged)
• Run pytest modules (PR is made)
• Build mkdocs site to ensure it can be built (PR is made)
• Serve mkdocs site and render (when PR is merged)
• Check version and release updates (when PR is merged)

README.md

Finish documentation for README.md

• Add Git LFS information
• Add how to obtain geospatial packages to successfully install requirements
• Show how to install within virtual environment