Bureau of Ocean Energy Management Geospatial Data Viewer

A web application for visualizing and analyzing biodiversity data collected during aerial surveys of offshore wind energy areas.

🔧 Installation

Prerequisites

• Python 3.8 or higher
• Git

Setup

1. Clone the repository:

git clone https://github.com/yourusername/BOEM-webapp.git
cd BOEM-webapp

2. Create and activate a virtual environment:

# On Windows
python -m venv venv
venv\Scripts\activate

# On macOS/Linux
python3 -m venv venv
source venv/bin/activate

3. Install required dependencies:

pip install -r requirements.txt

Environment Configuration

Create a .env file in the project root with the following configuration:

REPORT_SERVER_HOST=your_server_host
REPORT_SERVER_USER=your_username
REPORT_DIR=/path/to/reports/directory

Replace the values with your specific configuration:

• REPORT_SERVER_HOST: The host server for reports (e.g., hpg.rc.ufl.edu)
• REPORT_SERVER_USER: Your server username
• REPORT_DIR: Full path to the reports directory on the server

🚀 Running the Application

1. Ensure you're in the project directory with your virtual environment activated

2. Start the Streamlit app:

streamlit run app/main.py

3. The application will open in your default web browser at http://localhost:8501

📊 Data preparation

The app uses predictions and crops that are prepared by the prepare.py script. Run it before or after pulling new data:

python prepare.py

The script downloads metrics and predictions from Comet, then keeps only Gulf of Mexico flights. The set of flights to include is controlled by a text file so you don’t need to recompute from metadata:

• app/data/gulf_flights.txt — List of flight basenames to include (one per line). Blank lines and lines starting with # are ignored. Flight names in predictions are matched by basename (e.g. JPG_20241219_164400 matches 20241219_164400).

To add or remove flights, edit app/data/gulf_flights.txt and re-run prepare.py.

📁 Project Structure

BOEM-webapp/
├── app/
│   ├── main.py              # Main application entry point
│   ├── pages/              
│   │   ├── Model_Development.py
│   │   ├── Observations.py
│   │   ├── Video.py
│   │   └── ...
│   └── utils/
│       └── vector_utils.py
├── .env                    # Environment configuration
├── .vscode/
│   └── launch.json        # VS Code debug configuration
├── prepare.py             # Data preparation script
├── requirements.txt       # Python dependencies
└── README.md

🛠️ Features

• Interactive visualization of biodiversity survey data
• Marine wildlife species detection and classification
• Distribution maps and abundance estimates
• Temporal and spatial pattern analysis
• Video playback of flight line footage
• Image galleries of detected species

🤝 Contributing

1. Fork the repository
2. Create a new branch for your feature
3. Commit your changes
4. Push to the branch
5. Create a Pull Request

💬 Support

For support:

• Open an issue in the repository
• Contact the project maintainers

🛠️ Developer docs: Boem webapp

Overview

• Environment: conda env named boem-webapp
• Code location: /pgsql/boem-webapp/BOEM-webapp
• Service: systemd unit boem-webapp.service
• Dependency guard: boem-ensure-deps.sh runs before start and updates Python requirements only when requirements.txt changes, storing the current hash at /var/lib/boem-webapp/requirements.sha256

Cheat sheet (run from the repo directory)

cd /pgsql/boem-webapp/BOEM-webapp/

# Activate the app environment
conda activate boem-webapp

# Prepare data
python prepare.py
# or
sh prepare_data.sh

# Manage the service
sudo systemctl daemon-reload        # after editing the unit file
sudo systemctl stop boem-webapp.service        # to stop service
sudo systemctl restart boem-webapp.service

# Ensure the pre-start script is executable
sudo chmod +x boem-ensure-deps.sh

# Verify the service file if needed
sudoedit /etc/systemd/system/boem-webapp.service

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Bureau of Ocean Energy Management
• University of Florida Research Computing
• Streamlit team
• All contributors and maintainers