Examples Overview

Hercules includes several example cases that demonstrate different simulation configurations and capabilities. All examples use a centralized input system where data files are automatically generated and stored in the examples/inputs/ folder.

Available Examples

• 00: Wind Farm Only - Simple wind farm simulation with generated wind data

• 01: Wind Farm DOF1 Model - 1-DOF long-duration wind simulation

• 02: Wind Farm Realistic Inflow - Large-scale wind farm with longer running wind data

• 02b: Wind Farm Realistic Inflow (Precomputed FLORIS) - Optimized version using precomputed wake deficits

• 03: Wind and Solar - Hybrid wind and solar plant with interconnect limits

• 04: Wind and Storage - Wind farm with battery storage system

Input Data Management

All examples use centralized input files located in examples/inputs/:

• Wind data files (.ftr format)

• Solar data files (.ftr format)

• FLORIS configuration files (.yaml)

• Turbine model files (.yaml)

• PV system configuration files (.json)

Input files are automatically generated when first running any example using the ensure_example_inputs_exist() function.

Running Examples

Each example includes:

• hercules_input.yaml: Configuration file

• hercules_runscript.py: Main execution script

• plot_outputs.py: Output visualization script

To run any example:

cd examples/XX_example_name/
python hercules_runscript.py

No manual setup is required - all necessary input files will be automatically generated on first run.

Additional Resource Downloading and Upsampling Examples

Examples are provided in the examples/inputs/ folder demonstrating how to download wind and solar data using the hercules.resource.wind_solar_resource_downloader module and upsample wind data using the hercules.resource.upsample_wind_data module to create inputs for Hercules simulations.

• 03: Download NSRDB and WIND Toolkit Solar and Wind Data - Downloads a subset of solar and wind data for a small grid of locations for a single year from the NSRDB and WIND Toolkit datasets, respectively

• 04: Download and Upsample WIND Toolkit Wind Data - Downloads wind speed and direction for a small grid of locations for a single year from the WIND Toolkit dataset, then spatially interpolates the data at specific wind turbine locations and temporally upsamples the times series with added turbulence

• 05: Download Open-Meteo Solar and Wind Data - Downloads a subset of solar and wind data for a small grid of locations for a single year using the Open-Meteo API

• 06: Download and Upsample Open-Meteo Wind Data - Downloads wind speed and direction for a small grid of locations for a single year using the Open-Meteo API, then spatially interpolates the data at specific wind turbine locations and temporally upsamples the times series with added turbulence