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#

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.