search

nashville-data-nerds / think_tennessee

A place to coordinate and collaborate around analytic work with Think Tennessee (https://thinktennessee.org/)
Other
5 stars 2 forks source link

readme

Think Tennessee

A place to coordinate and collaborate around analytic work with Think Tennessee

Steps to getting started

  1. Fill out this form if you have not already as it will inform me about your interest and experience Non-profit Data Volunteering
  2. Sign the NDA and e-mail to nashville.data.nerds@gmail.com
  3. Contact nashville.data.nerds@gmail.com with the following information:
    • Your GitHub account to be added to the organization
    • Your desired AWS account in order to be added to the Nashville Data Nerds AWS account which is where all data will be shared via S3.

Reason for NDA (Non-Disclosure Agreement)

To provide context around the NDA, the data we will be working with is from the https://www.epi.org/ and is not publicly available and is shared with Think Tennessee for the explicit purpose of policy research.
If you are not familiar with NDA's, I highly recommend you always fully read an NDA before signing. Since the the data we are receiving is not publicly available, we need to be careful and respectful of Think Tennessee allowing us to use it.

If you have any questions about what is okay or not okay, please reach out to me, adantonison@gmail.com or @adantonison on slack, and I would be happy to talk further.

Things to do with the https://www.epi.org/ data

Things not to do with the https://www.epi.org/ data

Analysis Plan

This is the Analysis Plan for this project: State of Working Families in Tennessee Analysis Plan

Meeting Minutes

To see what is discussed in meetings, please checkout our Meeting Minutes Google Doc

Project Workflow

Overall Strategy

To reduce the amount of tools or websites people will need to access, we will be be managing all code and deliverables within GitHub.

Task Management

Tasks will be managed via GitHub issues. When creating an issue, please provide as much deatil as possible and apply appropriate labels.

Deliverable Feedback

Feedback for deliverables will be done through Google Docs. This will be faciliated by first opening a Pull Request in GitHub so your code can be reviewed. After you have spun up the Pull Request, please copy the visual as well as the description of the visual into a Google Doc stored here GDrive/ThinkTennessee/Visualizations with the same name as the folder. As you iterate on the visual, please attend the subsequent visuals to the Google Doc so we can the adjustments to the visuals.

Please include a link in the Pull Request to the Google Doc and a link to the Google Doc in the Pull Request. This will allow for a clear association between the code and the visual being worked on.

Source Control Strategy

We will be using a trunk based source control strategy. To summarize, you should create branches off of master for each issue you work on and you should make note the issue you are working in the Pull Request. I encourage people to open a pull request as they are working on the issue to help with getting timely feedback. See here if you are interested in more details around the Trunk Based source control strategy.

Technology

We will be using Python 3.7. We will be using Anaconda to help manage both python version as well as package management. Please see the following websites to get familiar with using Anaconda and managing environemnts within Anaconda.

This documentation covers how to add an environment to your Jupyter Notebook/Lab kernel listing. Add kernel to Jupyter Notebook/Lab