Running SCUBE

How do you run an analysis with SCUBE?

  • Open a miniforge/miniconda/conda terminal prompt

  • Activate the WEIS environment you set up

conda activate weis-env

  • Navigate to the root folder scube

  • Launch the analysis A<nn> L<m>, where nn stands for analysis number, for example 01 in the following example, and m the level number, for example 1 in the following example, with the following command:

python main.py A01 L1

Configuration file

Should you wish to change the position and/or name of some of the files and folders used by SCUBE, you should edit the config.yaml file in the root folder (scube) with your desired parameters before running the analysis.

An explanation of each configuration parameter is provided in the comments throughout the file.

# config.yaml

# INPUT
reference_turbine_yaml: "data/ref_turbines/IEA-15-240-RWT_VolturnUS-S.yaml"     # Reference floating wind turbine to be modified (all systems, defined as per WEIS convention)
environment_input:      "data/INPUT_environment.xlsx"                           # Input spreadsheet - location environmental conditions (wind, wave)
tower_geometry_input:   "data/INPUT_tower.xlsx"                                 # Input spreadsheet - tower characteristics (geometry, material)

# ANALYSIS
constraints_xlsx:       "CNSTR.xlsx"                        # Input spreadsheet - constraints to be imposed. NB All the constraints for all the analyses are in here. One tab for each analysis
constraints_sheet_fmt:  "constraints_{ANALYSIS}"            # Input spreadsheet - constraints for the specific analysis, naming convention

    ## WEIS
output_dir_base:        "data/weis_analyses"                # WEIS - WEIS output folder root
outputs_subdir:         "outputs"                           # WEIS - WEIS output folder
modeling_options_fmt:   "modeling_options_{ANALYSIS}.yaml"  # WEIS - WEIS input - modeling options yaml file
analysis_options_fmt:   "analysis_options_{ANALYSIS}.yaml"  # WEIS - WEIS input - analysis options yaml file

output_file_xlsx:       "{ANALYSIS}_output.xlsx"            # WEIS - WEIS output - xlsx output filename
output_file_yaml:       "{ANALYSIS}_output.yaml"            # WEIS - WEIS output - yaml output filename


# OUTPUT
modified_turbine_yaml:  "output/modified_IEA-15-240-RWT.yaml"   # WEIS - WEIS output - File of the modified floating wind turbine system (all the subsystems)
validation_report_folder: "output"                              # Scube - Output folder where the validation reports are saved