diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 7e94f66..739fcd3 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -1,5 +1,5 @@ { - "name": "2023-fall-clinic-climate-cabinet-devcontainer", + "name": "2024-winter-clinic-climate-cabinet-devcontainer", "build": { "dockerfile": "../Dockerfile", "context": "..", diff --git a/Makefile b/Makefile index eb3ba0c..e210fb2 100644 --- a/Makefile +++ b/Makefile @@ -7,8 +7,8 @@ current_abs_path := $(subst Makefile,,$(mkfile_path)) # pipeline constants # PROJECT_NAME -project_image_name := "2023-fall-clinic-climate-cabinet" -project_container_name := "2023-fall-clinic-climate-cabinet-container" +project_image_name := "2024-winter-clinic-climate-cabinet" +project_container_name := "2024-winter-clinic-climate-cabinet-container" project_dir := "$(current_abs_path)" # environment variables diff --git a/README.md b/README.md index 1340d12..8a65c35 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# 2023-fall-clinic-climate-cabinet +# 2024-winter-clinic-climate-cabinet ## Data Science Clinic Project Goals @@ -45,15 +45,31 @@ If you prefer to develop inside a container with VS Code then do the following s ## Team Members -Student Name: April Wang -Student Email: yuzhouw@uchicago.edu +## Repository Structure + +### utils +Project python code + +### notebooks +Contains short, clean notebooks to demonstrate analysis. + +### data + +Contains details of acquiring all raw data used in repository. If data is small (<50MB) then it is okay to save it to the repo, making sure to clearly document how to the data is obtained. + +If the data is larger than 50MB than you should not add it to the repo and instead document how to get the data in the README.md file in the data directory. + +This [README.md file](/data/README.md) should be kept up to date. + +### output +Should contain work product generated by the analysis. Keep in mind that results should (generally) be excluded from the git repository. + + +## Team Member Student Name: Nicolas Posner Student Email: nrposner@uchicago.edu -Student Name: Aïcha Camara -Student Email: aichacamara@uchicago.edu - Student Name: Alan Kagiri Student Email: alankagiri@uchicago.edu.