/quake-ds-pt9

Primary LanguageJupyter NotebookMIT LicenseMIT

Maintainability

Test Coverage

Epicentral

You can find the project at Epicentral on Heroku.

Contributors

|Tally Wiesenberg||Rob LeCheminant |Jerimiah Willhite|

| | |

| | |

:-----------------------------------------------------------------------------------------------------------: |

Project Overview

Trello Board

Product Canvas

Earthquake data is spread out on the internet and finding up-to-date data on your location involves sifting through complicated user interfaces and technical jargon. Personal safety and earthquake/emergency resources shouldn't be this hard to find. Knowledge about earthquakes also should also be more available, so people can manage their risk appropriately.

Earthquake data is spread out on the internet and finding up-to-date data on your location involves sifting through complicated user interfaces and technical jargon. Personal safety and earthquake/emergency resources shouldn't be this hard to find. Knowledge about earthquakes also should also be more available, so people can manage their risk appropriately.

Epicentral intends to centralize Earthquake data on an accessible, easy-to-understand platform. The center of the project is a live map that reports the magnitude of recent earthquakes. Later iterations will include SMS notifications of earthquakes and predictions of aftershocks.

Deployed Front End

Tech Stack

Python, geopandas, flask, Folium, leaflet, numpy, pandas, pytorch, scikit-learn

Predictions

This is scheduled for RC3

Explanatory Variables

  • Scheduled for RC3

Data Sources

How to connect to the data API

The Flask app currently has four routes that can be used by the Front End or other users to both store and access data:

  • /grabquakes:
  • /map:
    • This displays a Folium map with the earthquake information in the database.
  • /getquakes:
    • This returns all earthquake data by default, but can be filtered with string queries, with the 'mag' and 'date' arguments allowed.
    • Expected values for 'mag' are: any float.
    • Expected values for 'date' are: w, 2w, or m.
    • These stand for 'week', '2 weeks', and 'month' respectively.
  • /emergency/:
    • This route looks up the name of the city passed into it, and returns a summarization of the city's official earthquake emergency preparedness-related website.

How to Reproduce locally

Run the following commands to install all necessary packages:

conda create --name quake python==3.7
conda activate quake
conda install -c conda-forge --file requirements.txt

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

  • Check first to see if your issue has already been reported.
  • Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
  • Create a live example of the problem.
  • Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

  • Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  • Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
  • Ensure that your code conforms to our existing code conventions and test coverage.
  • Include the relevant issue number, if applicable.
  • You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

See Backend Documentation for details on the backend of our project.

See Front End Documentation for details on the front end of our project.