soobinrho / beemovr Goto Github PK

Who are we?

Maps for beekeepers. We called beekeepers all over the country and asked them, "We want to help you save bees. What can we do for you? We can program."

Keith Robert from the Valley Hive in California explained that beekeepers are sometimes forced to relocate their beehives - e.g. California drought - and they can't just move into any location. They need to find an area that has the highest survival rate and the best nectar availability for their colonies. That's how BeeMovr started. [YouTube]

1. How to spin up a development server
2. How we deploy to beemovr.com
3. How does this work?

Special thanks to Keith Robert from The Valley Hive, our favorite beekeeper, and John Nagro from Isitwater API for supporting us through API credits.

Also, our work would not have been possible without the paper "The Impact of Precipitation and Temperature on Honey Yield in the United States" (Hayes Kent Grogan, 2020, Auburn University). This paper is what made our core prediction model possible.

BeeMovr started as a HackMIT project.

The issue we are addressing

Whenever beekeepers need to relocate their colonies, they need to find an area that has the higest survival rate and the maximum potential for honey yield. BeeMovr allows our users (beekeepers ♥) to do exactly that.

What BeeMovr does

We can calculate honey-yield prediction value of any given coordinates.

The idea behind BeeMovr

BeeMovr utilizes real-time precipitation, maximum temperature, and minimum temperature data from Open Meteo API to calculate prediction of the maximum possible honey yield value of any given coordinates on a map based on Hayes Kent Grogan's paper. Our project seeks to provide beekeepers with better information about ideal pollinator conditions near them in order to increase colony survival rates and reduce uncertainty. We focused on researching the most accurate model possible and we now use a linear regression model with the factors of precipitation, maximum temperature, and minimum temperature. Further, we plan to use watsonx.data to pull combined data from USDA (U.S. Department of Agriculture) and NASS (National Agricultural Statistics Service) for improved prediction models.

We envision BeeMovr to become the de-facto map for helping beekeepers make an informed decision about what's best for their bees. We aim to create the beekeeper's map, the first feature of which is maximum potential honey yield prediction, but as we iterate with our beekeepers, we'll listen to what their (and their bees') needs are, and we'll incrementally add those features. We therefore believe that the most important part of BeeMovr is to listen, understand, and deliver what the beekeepers want and need to serve their bees.

BeeMovr has been and will always be open-sourced and open to all beekeepers. If you're a beekeeper and have any suggestions or feature requests, please feel free to email us at <[email protected]>.

How will you support this project going forward?

We designed BeeMovr to be as self-sustainable as possible by minimizing the operational costs. We'll maintain it as a free, open-source software. The historical weather data API from Open Meteo we use for honey-yield prediction is free thanks to Open Meteo's generosity, as well as OpenStreetMap's support for open-source community and Mapbox providing 50,000 map loads per month for free.

Yes, we'll have to temporarily stop our website if the map loads go over 50,000 and wait until the quota resets the next month, but we anticipate this will be fine with the use cases of our users, since doing this allows our program to be completely free for everyone.

# ---------------------------------------------------------------------
# Development workflow.
# ---------------------------------------------------------------------
cd BeeMovr

# Install pnpm: package manager that is faster and more disk efficient
npm install -g pnpm
pnpm setup

# If you're using zsh:
source ~/.zshrc

# If you're using bash:
source ~/.bashrc

# Install dependencies.
pnpm install

# Go to https://mapbox.com and get an API token.
# Then, copy and paste the token to `.env.local` file.
# Mapbox has a free tier of 50,000 map loads per month.
cp ./.env.development ./.env.local

# Run a development server.
pnpm dev

# ---------------------------------------------------------------------
# Deployment workflow.
# ---------------------------------------------------------------------
# Our server is an Ubuntu box on Hetzner with 3 vCPU, 4GB RAM, and
# 80GB SSD, which amounts to only $8 per month. We wanted to make our
# program as sustainable as possible, so we tried to use the most
# reliable, yet the most inexpensive server available.
ssh <username>@<ip address>
cd ~
git clone https://github.com/soobinrho/BeeMovr
cd BeeMovr
cp .env.production .env.local

# For development purposes, just running `cd ./BeeMovr && pnpm dev` is
# perfect, and in fact that is how we run a development server all the
# time for testing purposes. However, if you want to run a production
# server, by which we mean deployment to a server so that it becomes
# available to everyone on the internet, we use Docker Compose to
# deploy Next.js through Node.js and reverse proxy that through Nginx.
docker compose up -d

# ---------------------------------------------------------------------
# How we re-deploy whenever we make changes to our code.
# ---------------------------------------------------------------------
cd BeeMovr
git pull
docker compose build --no-cache && docker compose up --force-recreate -d

We created a separate section for all of our development logs.