adambsokol / purple_haze Goto Github PK

Unless it has to be in that location to run properly, you might want to move purple_haze_app.ipynb to an examples folder in the repository root or a notebooks folder in the package.

Regardless, I like to pointer to it in the README.md which was a nice touch.

• Functional
  • https://github.com/adambsokol/purple_haze/blob/main/docs/functional_specification.md
  • Problem being addressed
    • What is the relationship between air quality, air quality testing, and socioeconomic status?
  • Data sources, data structure
    • Seattle PurpleAir sensors, multiple csv files per sensor
    • Seattle's Open Data Program Racial and Social Equity Composite Index (RSECI) dataset, shapefile
  • Users: domain, skills, programming experience
    • Researchers who can use Jupyter notebooks and Python
  • At least 2 use cases
    • "I want to find the number of PurpleAir sensors within a census tract in Seattle"
    • "I want to compute the PM2.5 and AQI averages for each census tract in Seattle"
• Component
  • https://github.com/adambsokol/purple_haze/blob/main/docs/component_specification.md
  • 3+ software components: what it does, inputs it requires, and outputs it provides.
    • These components are well specified, nice work!
    • "Organizing Purple Air Data Files"
      • splits air quality data on census tract
    • "Reading & Analyzing Purple Air Data"
      • Add air quality calculations
    • "Visualization"
      • Plot data in Jupyter notebook
  • Preliminary plan
    • Prioritize continuous integration and unit testing
    • Don't worry too much about choosing the wrong kind of map, just try to get a simple example working and iterate from there if you have time.

There is usually a test directory in the package root that holds the unit test .py files.

Not sure what the __main__.py file is doing in the repo root. Maybe it is required for the nature of your code, but you should provide some documentation about it.