ece229

Project Repo for Computational Data Analysis Course

This project is a US NEwborn Analysis System. The purpose is helping users to search the trend of thier name of each year and analyse the name by year, region and gender.

visit the project website http://34.212.234.66:8050

(avoid using UCSD-GUEST to visit the page, use UCSD-PROTECTED instead)

Table of Contents

1. Package Dependencies
2. File Structure
3. Run Code
4. User Story
5. About Dataset
6. Testing
7. Documentation

Package Dependencies

To run any of the module in this codebase, ensure the newest version of python3 or the newest version of Anaconda is installed on the machine. Further, ensure the respective binary is in the list of PATH variables.

The project depends on numpy, dash, dash-bootstrap-components

For installing the Environment Config:

$ pip install numpy
$ pip install dash
$ pip install dash-bootstrap-components

File Structure

• client
  • baby-names-state.csv (should be added manually)
  • app.py
  • EntryHomepage.py
  • nameTrend
  • top5Name,py
  • USHeatMap.py
• test
  • __init__.py
  • test_callback.py
  • test_ui.py
• doc
  • build
  • source
• EntryHomepage.py

Run Code

1. Download or git clone this github repository.

git clone https://github.com/js-konda/ece229.git

2. Install the necessary dependencies:

Using Pip

pip install -r requirements.txt

3. Download the dataset and place the dataset into the client directory

4. For Entering the Homepage Dashboard:

python client/EntryHomepage.py

4. The output will be displayed in port 8050

User Story

Choosing a name is one of the most important decisions parents have to make. It is one of the child’s first milestones and can shape its future. A name can signify that the baby is accepted as one of the family members. By checking the trend of names in the specific area, one can draw inspiration from it which makes it easier to name the child. For those who already have several options, we can help them make the desicion based on the data we have.

Our proposed solution is to analyze the differences in naming between regions and the trend of naming from 1910 to 2021. We try to answer questions like which name is most popular in the past 10 years in California, does there exist an obvious distinction between east and west or when did my name become a hit nationwide. We will create interactive histograms and plots to allow users to find the trend of a specific name during a specific time period within a state/nationwide. We will also make a recommendation by showing the trend changes of top 5 most popular baby names over the years.

The real world application of this solution is that it can serve as a reference that helps parents better name their children, such as avoiding the most popular names, finding gender-neutral names, etc.

About Dataset

This dataset consists of American newborn babies' names statistics from 1910 to 2021. It contains important information for those names including gender, state and number of those names in a given area during a certain year.

Testing

1. Test Environment

$ pip install pytest

2. Run test To run pytest, you will need to navigate to root directory and type the following command

$ pytest -v

Documentation

Our project used Sphinx to create a documentation static website as an ongoing part of development. Open ./doc/build/html/index.html file in web browser to see the docs.

or visit doc