Skip to content
Kaylin Rackley edited this page Dec 2, 2022 · 44 revisions

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Glacier Project

The Glacier Project is a web application that visualizes data, satellite images, and predictions of our planets glaciers.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About

Current Features include:

  • Filtering by country and displaying the location of a glacier on a map
  • Displaying mass change data based on recordings by the WGMS
  • Downloading CSV files of data
  • Displaying raster plots of the elevation in a small area around a glacier

Built With

  • React
  • Typescript
  • R Shiny
  • Flask
  • MongoDB

(back to top)

Getting Started

To get a local copy up and running, follow these simple example steps.

Prerequisites

Installation

  1. Ask project lead to add a new contributor to the repository
  2. Install and unzip .7z starter files
    • Store anywhere that is easy and convenient to access (i.e. desktop)
  3. Open RStudio and access unzipped files
  4. Set working directory to the folder storing all program files
    • Session --> Set Working Directory --> Choose Directory --> Set as Working Directory
  5. Change paths in test_with_all_glaciers to path FROM your working directory
  6. Run test_with_all_glaciers first to get data together
  7. Run (Ctrl + A, Ctrl + Enter)
    • Install additional libraries as needed upon request by RStudio
  8. Update line 32 to gmap_data <- sub_data[, c(1, 7, 8, 3)] if not already done
  9. Run app.R
    • Do NOT change paths in this file.

Known Issues

RStudio Library Package Problems:

Multiple times, while downloading a R library, I ran into an error where RStudio would be unable to find the right place to download it to. In order to remedy this, first make sure you're in the correct directory by opening and right clicking on app.R. Select "set working directory". If this doesn't work, follow the path C:\Users\User\Documents\R\win-library and deleted the 4.0/00LOCK (or whatever version you see) file.

Usage

(back to top)

Roadmap

End of September:

  • Agree on a frontend design
  • Agree on and transfer all data to server
  • Create a better onboarding guide

End of October:

  • Create scripts that predict glacier mass based on scientific models
  • Display satellite data from OpenGeo API
  • Improve API
  • Bug fixes

End of November:

  • Continue to refine October goals and begin implementation of December goals

End of December

  • Implement and display glacier mass predictions on app
  • UI update
  • Display satellite images with highlights on app for each glacier
  • Deploy* (BIIIIIIG astrix)

See the open issues for a full list of known issues.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Acknowledgments

Contact

Your Name - @Cool_Kid420 - email@email_client.com

Project Link: https://github.com/dinobenj/GlacierProject

(back to top)

Footer © 2022 GitHub, Inc. Footer navigation Terms Privacy Security Status Docs Contact GitHub Pricing API Training Blog About

Clone this wiki locally