<commit_before># Functional specification

Problem Statements
1. Select criteria for city ranking
2. Data collection and joint
3. Create tools for visualizing city and information about selected factors

## User profile

  The computational environments the user should be familiar with are listed as:
  - web pages
  - excel
  - python
  - Jupyter notebook

  *Zhuochen: This part we should discuss in details, such as whether we design GUI; if we want to show on the webpage, how to do the related API (for example wordpress?); if offline use, do we want to smart phone base or computer base?*

  Also, the user need to be willing to choose the criteria as well as allocate
  weight value to each selected factors themselves to score city.

## Elements

  There will be four main categories for users to choose in the database:
  - Environmental
  - Society
  - Economy
  - Tertiary Industry

### *Research part

 - Top environmental-friendly (social, developed or culturally important) cities
 - Any correlations of those factors? PCA analysis

### Tool part

- Data description and combination
- Default output from known factor weights: map info and other graphic outputs
- Interactive (user DIY) user profile*



## Use Case
  1. Select factors and get the rank based on each single factor
  2. Rank the city based on all the chosen criteria
  3. Rank the city by adding weight value for each factor
<commit_msg>add Elements and user profile thought by italics type<commit_after># Functional specification

Problem Statements
1. Select criteria for city ranking
2. Data collection and joint
3. Create tools for visualizing city and information about selected factors

## User profile

  The computational environments the user should be familiar with are listed as:
  - web pages
  - excel
  - python
  - Jupyter notebook

  *Zhuochen: This part we should discuss in details, such as whether we design GUI; if we want to show on the webpage, how to do the related API (for example wordpress?); if offline use, do we want to smart phone base or computer base?*

  Also, the user need to be willing to choose the criteria as well as allocate
  weight value to each selected factors themselves to score city.

## Elements

  There will be four main categories for users to choose in the database:
  - Environmental
  - Society
  - Economy
  - Tertiary Industry

### *Research part*

 - *Top environmental-friendly (social, developed or culturally important) cities*
 - *Any correlations of those factors? PCA analysis*

### *Tool part*

- *Data description and combination*
- *Default output from known factor weights: map info and other graphic outputs*
- *Interactive (user DIY) user profile*



## Use Case
  1. Select factors and get the rank based on each single factor
  2. Rank the city based on all the chosen criteria
  3. Rank the city by adding weight value for each factor

{'fraction_non_alphanumeric': 0.046398891966759004, 'fraction_numerical': 0.004155124653739612, 'mean_word_length': 3.791044776119403, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '402121', 'n_tokens_mistral': 739, 'n_tokens_neox': 688, 'n_words': 428}