Add Building Grades Data

.gitignore

@@ -2,6 +2,7 @@ node_modules/*
 .cache/*
 src/.temp/*
 
+**/.ipynb_checkpoints/*
 # Ignore root dist directory from `gridsome build`, we need src/data/dist
 dist/*
 

run_all.sh

@@ -6,4 +6,6 @@ python3 -m src.data.scripts.process_data
 
 python3 -m src.data.scripts.add_context_by_property_type
 
-python3 -m src.data.scripts.clean_and_pare_down_data_current_year
+python3 -m src.data.scripts.clean_and_pare_down_data_current_year
+
+python3 -m src.data.scripts.grade_buildings

src/data/dist/README.md

@@ -0,0 +1,3 @@
+# Files
+
+`Historical_GHG_Factors.xlsx`: These data are from [`Energy Star's Historical Greenhouse Gas Factors, 2000 – present`](https://www.energystar.gov/buildings/tools-and-resources/historical-greenhouse-gas-factors-2000-present). When the `Subregion` is `NaN`, Energy Uses the national factor (i.e. no division by subregion for those energy sources).

src/data/requirements.txt

@@ -1,4 +1,5 @@
 python-slugify==4.0.1
 pandas==2.1.2
+scipy==1.11.3
 numpy
 pytest==7.4.4

src/data/research/README.md

@@ -0,0 +1,27 @@
+# README
+
+This is how you set up an environment for research development.
+
+In bash, from this `README.md`'s directory, `cd` to the `docker` directory.
+From there:
+
+```bash
+docker compose build && MY_UID="$(id -u)" MY_GID="$(id -g)" docker compose up
+```
+
+Note: `MY_UID="$(id -u)" MY_GID="$(id -g)"` is to pass permissions to the
+Jupyter user inside the container to make changes that are persistent on the
+host side with appropriate host user permissions; e.g. a Jupyter notebook file
+that a host user can edit.
+
+To add Python dependencies:
+
+```bash
+docker exec -it docker-bldg-grade-dev-1 bash
+cd ~/work/docker
+poetry add [name_of_package]
+```
+
+To do some research, you can go to the Jupyter Server link that is in the
+compose logs and paste it into your browser. Within the Jupyter GUI, navigate
+to `work/src/data/research/building_grade_eda.ipynb` for data exploration.