Merge pull request #46 from UBC-MDS/dev

Milestone - II changes

Author: vtaskaev1

.gitignore

@@ -3,127 +3,5 @@ __pycache__/
 *.py[cod]
 *$py.class
 
-# C extensions
-*.so
-
-# Distribution / packaging
-.Python
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-pip-wheel-metadata/
-share/python-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-MANIFEST
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.nox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-*.py,cover
-.hypothesis/
-.pytest_cache/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# IPython
-profile_default/
-ipython_config.py
-
-# pyenv
-.python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
-.env
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
-
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
-
-# Pyre type checker
-.pyre/
+# Notebook files
+.ipynb_checkpoints/

Procfile

@@ -0,0 +1 @@
+web: gunicorn src.app:server

README.md

@@ -1,8 +1,48 @@
-# Tsunami Events Dashboard (Python) 
-This app will contain a landing page with three tiles; an interactive geographical map that users can pan across to see the location of each tsunami as well as its strength, a time series graph showing the number of deaths by country, and a table presenting the top 10 strongest tsunamis. All three graphics will be filterable by using the collapsible menu which contains two widgets; a slider to select a range of years and a dropdown menu to filter which countries they would like to see. The geographical map makes use of the latitude and longitude in the data set to identify locations where a tsunami occurred and will have a heat map to represent the magnitude of the tsunami as well as the ability for users to hover over a tsunami to glean more information about a particular tsunami. Similarly, users will also be able to use this feature in the table of strongest tsunamis which will have a dropdown to select the top 5, top 10, or top 20 strongest tsunamis of the chosen period. Lastly, the time series graph will show the number of deaths by country and is filterable by a period and countries.
+# Tsunami Events Dashboard (Python)
+
+## Accessing the App via Heroku
+
+Link to Live App: [Tsunami Events Dashboard](https://tsunami-events-dashboard.herokuapp.com/)
+
+## Description of the App Interface
+
+This app contains a landing page with three tiles: an interactive geographical map that users can pan across to see the location of each tsunami as well as its strength, a time series graph showing the number of deaths by country, and a table listing the strongest tsunamis. The tsunami events data underlying the three plots is filtered for using a collapsible menu that contains two widgets: a slider to select a range of years of occurrence, and a drop-down menu to filter for countries impacted. The geographical map makes use of the tsunami latitude and longitude location data, generates a heat map to indicate tsunami magnitude, and allows users to hover over tsunami events plotted on the map to glean more comprehensive event details. Users can also peruse of a table listing the strongest tsunami events per the year and country selection applied, with the option to select from among a display of the top 5, 10 , 20 strongest events. Lastly, the time series graph shows the number of deaths by country per the year and country selection applied.
 
 ## Proposal
-Our proposal can be found via this link: [proposal](proposal.md)
+
+Our proposal can be found via this link: [proposal](docs/proposal.md)
 
 ## Dashboard Sketch
+
 ![dashboard sketch](img/tsunami_sketch.jpg)
+
+## Accessing the App Locally
+
+To run and explore the app locally, clone the git repo and install required dependencies:
+
+    git clone https://github.com/UBC-MDS/tsunami-events-dashboard-python.git
+
+    pip install -r requirements.txt
+
+Then, run the app:
+
+    python src/app.py
+
+## Built with
+
+-   [Dash](https://dash.plot.ly/) - Main server and interactive components
+-   [Altair](https://altair-viz.github.io/index.html) - Used to generate interactive plots, using Python
+-   [Pandas](https://pandas.pydata.org/) - Used for data wrangling and pre-processing
+
+## Contributing
+
+| Contributors         | Github                |
+|----------------------|-----------------------|
+| Gautham Pughazhendhi | \@gauthampughazhendhi |
+| Jacqueline Chong     | \@Jacq4nn             |
+| Rowan Sivanandam     | \@Rowansiv            |
+| Vadim Taskaev        | \@vtaskaev1           |
+
+## License
+
+[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/UBC-MDS/532-Group21/blob/main/LICENSE)