Skip to content

weecology/BOEM-webapp

Repository files navigation

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
  1. 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
  1. 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
  1. The application will open in your default web browser at http://localhost:8501

πŸ“ 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

πŸ“œ 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