jgte29 / team-harvey-wiley-proj04

0 stars 0 forks source link

EEP 153 Spring 2024 - Project 04 (Team Harvey Wiley)

Team Members

Jordan Taqi-Eddin - jgte29@berkeley.edu; GitHub: jgte29

Samantha Wu - samanthawu@berkeley.edu; GitHub: wusamantha

Kimberley Fan - kimberley.fan123@berkeley.edu; GitHub: kimberleyfan

Taylor Lacey - taylorlacey@berkeley.edu; GitHub: tlacey17

Bolor Erdene-Ochir - bolorerdene@berkeley.edu; GitHub: bolorerdene

Welcome

Welcome to the Project 04 GitHub Repository for Team Harvey Wiley. Our code for the project is organized in the following format:

How to Use

  1. Option A: Access Our Repository Via DataHub (Highly Recommended)
    • You can access all of the code in our repository via DataHub using this link.
  2. Option B: Clone the repository on your local device:
    git clone https://github.com/jgte29/team-harvey-wiley-proj04.git

General Usage Notes:

  1. Updating Notebook:
    • If you make changes locally to your version of the notebook, you will need to manually update the notebook via the following steps i) Uncomment the code in the cell below and run it. ii) Restart the notebook's kernel. iii) Refresh the page.
      Warning - Make sure that the aforementioned code is commented once you successfully updated the notebook.
      ### Uncomment this code to manually update the notebook
      # !git reset --hard origin/main
  2. Loading in Packages:
    • If need be, you may need to load in some python packages to run all of the code successfully. You can do so via the following steps: i) Uncomment the code in the cell below and run it. ii) Restart the notebook's kernel. iii) Refresh the page.
      Tip - It may be helpful to comment out the code below once you successfully load in the packages.
      ### Uncomment this code to load in the packages
      # !pip install -r requirements.txt

Notebook Specific Notes:

  1. master_notebook.ipynb:
    • To test the functionality of all our code, only this notebook needs to be run. If it works, it indicates that all of the code in the other notebooks are properly running.
    • Understanding Nutritional Adequacy
      • We choose to adopt a nuanced approach to examing Nutritional Adequacy in our project. The best way to explain our approach is through an example. Suppose we have the following nutritional requirements and consumption data for some arbitrary household.
Nutrient A B C D Adequacy Share
Intake 105 kg 53 kg 75 kg 29 kg
Requirement 100 kg 100 kg 100 kg 100 kg
100% Adequacy $\times$ 0.25
75% Adequacy $\times$ $\times$ 0.50
50% Adequacy $\times$ $\times$ $\times$ 0.75

As we see in the able above, Adequacy Share at some Adequacy Level $\alpha$ is the proportion of nutrients for which a housholds total intake of the nutrient is greater than or equal to $\alpha$.