Remote OpenFAST Plotter Documentation

Welcome to the Remote OpenFAST Plotter documentation. This web-based application is designed for visualizing and analyzing OpenFAST simulation outputs, with a focus on wind turbine data analysis.

About Remote OpenFAST Plotter

The Remote OpenFAST Plotter is a specialized tool for wind energy researchers and engineers who need to analyze OpenFAST simulation results. It provides a user-friendly, web-based interface accessible from any modern browser, making it ideal for:

• Working with simulation data on remote servers without transferring large files

• Interactive visualization of time series data from wind turbine simulations

• Performing frequency domain analysis with Fast Fourier Transform (FFT)

• Analyzing phase relationships between different signals

• Creating exportable, shareable visualizations

Features

• Fast Loading: Efficiently loads OpenFAST output files using parallel processing

• Time Domain Analysis: Interactive plots of simulation data over time

• FFT Analysis: Frequency domain analysis with configurable parameters

• Phase Analysis: Examine phase relationships between selected signals

• Frequency Annotations: Mark and label important frequencies in FFT plots

• File Path Management: Save and reuse sets of file paths for analysis

• HTML Export: Generate standalone HTML files for sharing results

• Remote Accessibility: Access via web browser when running on remote machines

Contents:

• Installation
  • Prerequisites
  • Installation Methods
  • Starting the Application
  • Command Line Options
  • Downloading Test Files
  • Troubleshooting
• User Guide
  • Getting Started
  • Overview
  • Basic Workflow
• Remote OpenFAST Plotter Architecture
  • Overview
  • Module Structure
  • Data Flow
  • Adding New Features
  • Testing
  • Deployment
• API Documentation
  • Application
  • Core Modules
  • Specialized Modules
  • Callback Organization
  • Tools Package
• Examples
  • Basic Workflow
  • Time Series Analysis
  • FFT Analysis
  • Phase Analysis
  • Working with Annotations
  • Basic Workflow
  • Time Series Analysis
  • FFT Analysis
  • Phase Analysis
  • Working with Annotations
• Frequency Annotations
  • Why Use Annotations?
  • Using the Annotation System
  • Common Annotation Practices
  • Example Workflow
  • Best Practices
• Development
  • Contributing
  • Testing
  • Extending
  • Development Environment Setup
  • Code Organization
  • Testing
  • Adding New Features
  • Building Documentation

Getting Started

A quick introduction to get started with Remote OpenFAST Plotter:

# Install dependencies
pip install -r requirements.txt

# Start the application
python app.py

# Access the application
# Open http://localhost:8050 in your browser

For testing with example data:

# Download test OpenFAST files
python utils/download_test_files.py

Documentation Development

Portions of this documentation were developed with the assistance of GitHub Copilot, a generative AI tool based on OpenAI’s technology. This includes the file management documentation and other supplementary content. For more details on how AI was used in the development process, see the AI-assisted development section.

Indices and tables

• Index

• Module Index

• Search Page

License

This software is distributed under the Apache License, Version 2.0.