oceanhackweek / ohw24_proj_HAB_FE_us

0 stars 0 forks source link

P.A.C.E.: People Accessing Cool Examples

Collaborators

Name Location Role
Adelle Bigelow Participant
Adam Bigelow Participant
Kasandra Bigelow Participant

Project Description

The goal is to create an app that will use Streamlit to make it easy to view and explore PACE (Plankton, Aerosol, Cloud, ocean Ecosystem) data, with a focus on algal blooms. The app will let users interact with the data through simple controls like sliders and date selection, and see some updates in real time. It will be easy to use, gathering data from different sources and showing it in a clear way. We worked on building and testing the app, using Streamlit and other libraries, while making sure the data fits together well.

Planning

Resources

To run this application: streamlit run --server.runOnSave true app/app.py

This README includes instructions on how to spin up your very own Streamlit app locally.

Unfortunately, we were not able to figure out how to run this in JupyterHub

Instructions using conda (please note this workflow has not been extensively tested so please get assistance from someone familiar with setting up local environments)

  1. Install conda/miniconda/anaconda: https://docs.anaconda.com/ There are two options:
  2. In your computer's terminal a. git clone repo b. conda create --name env-name c. conda activate env-name d. pip install -r requirements.txt which can be copied from this repo and customized to include the packages you need or
  3. In your computer's terminal a. git clone repo b. conda env create -f environment.yml c. conda activate ohw-streamlit
  4. Create streamlit.py which you can name whatever you want
  5. Examples in the tutorial here: https://github.com/oceanhackweek/ohw24_proj_HAB_FE_us/tree/main/tutorial
  6. Add your code!
  7. Run streamlit run streamlit.py or update to use your file name If you would like the app to update every time you save (this is good for debugging) run streamlit run --server.runOnSave true streamlit.py

Instructions using Pixi:

  1. Install Pixi
  2. In your computer's terminal a. git clone <REPO_NAME> b. pixi init