Software Attributes

The sections here tabulate the software attribute database. Each attribute (column) is described in the Attribute Schema. Some columns contain lists of strings which means that they cannot be fully sorted. Instead, they can be filtered by searching for a string in the search box

Show code cell content

Hide code cell content

from pathlib import Path
import yaml
from itables import init_notebook_mode
import pandas as pd

init_notebook_mode(all_interactive=True)

software_attr_dir = Path("..", "..", "software_attributes")
model_list_inputs = yaml.safe_load( open(software_attr_dir / "database_list.yaml", "r") )
models = model_list_inputs["active"]

model_attributes_map = {
    model: yaml.safe_load( open(Path("..", "..", "software_attributes", "database", f"{model}.yaml"), "r") )
    for model in models
}

df = pd.DataFrame.from_dict(model_attributes_map, orient="index")
# print(list(df.columns))
# print(df)

General

Show code cell source

Hide code cell source

# Get all columns that begin with "does_"
does_columns = [col for col in df.columns if col.startswith("does_")]

# Make a list of all the "does_" columns that are True for each row dropping the "does_" prefix
# Add this to the dataframe
for i, row in df.iterrows():
    does_list = [col.replace("does_", "") for col in does_columns if row[col]]
    # print(f"{i}: {does_list}")
    df.at[i, "does"] = does_list

general_df = df[[
    "does",
    "programming_language",
    "license_type",
    "data_collection_methods",
    "last_release_date"
]]
general_df

ⓘ	does	programming_language	license_type	data_collection_methods	last_release_date
amr-wind	[simulation]	c++	bsd-3-clause	[modeling]	TODO
dw_tap	[data_analysis, design_optimization]	python	gpl-3.0	[field, modeling]	2023-09-05
dwind	[data_analysis]	python	gpl-3.0	[modeling]	2023-09-05
erf	[simulation]	c++	NaN	[modeling]	2023-06-30
fastfarm	[controls, simulation, loads]	fortran	apache-2.0	[modeling]	2023-05-16
flasc	[data_analysis]	python	apache-2.0	[modeling, field]	NaN
floris	[controls, design_optimization, simulation]	python	apache-2.0	[modeling]	2023-07-27
hercules	[simulation, loads]	python	apache-2.0	[modeling]	NaN
hopp	[controls, costs, design, design_optimization, simulation]	python	bsd-3-clause	[modeling]	2021-04-30
kynema	[simulation, loads]	c++	mit	[modeling]	TODO
(17 more rows not shown)

Turbine Modeling

Show code cell source

Hide code cell source

turbine_df = df[[
    "scope",
    "system_location",
    "time_domain",
    "turbine_model",
    "does_loads",
    "does_design_optimization",
    "does_costs",
]]
turbine_df = turbine_df[ pd.DataFrame( turbine_df["scope"].tolist() ).isin( ["turbine", "any"] ).any(axis=1).values ]
turbine_df

ⓘ	scope	system_location	time_domain	turbine_model	does_loads	does_design_optimization	does_costs
amr-wind	[turbine, farm, atmosphere]	[any]	dynamic	[actuator, geometry_resolved]	False	False	False
dw_tap	[turbine, farm]	[land]	dynamic	[N/A]	False	True	False
dwind	[turbine, farm, system]	[land]	dynamic	[multibody_bem]	False	False	False
fastfarm	[farm, turbine, atmosphere]	[any]	dynamic	[multibody_bem, vortex_method]	True	False	False
flasc	[turbine, farm, system]	[any]	steady	[lookup_table, SCADA]	False	False	False
floris	[turbine, farm, system, atmosphere]	[any]	steady	[lookup_table]	False	True	False
hercules	[turbine, farm, atmosphere]	[any]	dynamic	[actuator]	True	False	False
kynema	[turbine]	[any]	dynamic	[multibody_bem]	True	False	False
landbosse	[turbine, system]	[any]	steady	[lookup_table, regression]	False	True	True
nalu-wind	[turbine, farm]	[any]	dynamic	[actuator, geometry_resolved]	True	False	False
(13 more rows not shown)

Farm Modeling

Show code cell source

Hide code cell source

farm_df = df[[
    "scope",
    "system_location",
    "time_domain",
    "turbine_model",
    "wake_model",
    "does_loads",
    "does_design_optimization",
    "does_costs",
]]
farm_df = farm_df[ pd.DataFrame( farm_df["scope"].tolist() ).isin( ["farm", "any"] ).any(axis=1).values ]
farm_df.dropna()

ⓘ	scope	system_location	time_domain	turbine_model	wake_model	does_loads	does_design_optimization	does_costs
amr-wind	[turbine, farm, atmosphere]	[any]	dynamic	[actuator, geometry_resolved]	[navier_stokes]	False	False	False
dw_tap	[turbine, farm]	[land]	dynamic	[N/A]	[N/A]	False	True	False
dwind	[turbine, farm, system]	[land]	dynamic	[multibody_bem]	[N/A]	False	False	False
fastfarm	[farm, turbine, atmosphere]	[any]	dynamic	[multibody_bem, vortex_method]	[dynamic_meandering, vortex_method]	True	False	False
flasc	[turbine, farm, system]	[any]	steady	[lookup_table, SCADA]	[analytical]	False	False	False
floris	[turbine, farm, system, atmosphere]	[any]	steady	[lookup_table]	[analytical]	False	True	False
hercules	[turbine, farm, atmosphere]	[any]	dynamic	[actuator]	[navier_stokes]	True	False	False
hopp	[farm, system]	[any]	dynamic	[regression, lookup_table, multibody_bem]	[analytical]	False	True	True
moorpy	[farm, system]	[floating_offshore]	[frequency]	[N/A]	[N/A]	True	False	False
nalu-wind	[turbine, farm]	[any]	dynamic	[actuator, geometry_resolved]	[navier_stokes]	True	False	False
(6 more rows not shown)

Cost Modeling

Show code cell source

Hide code cell source

cost_df = df[[
    "scope",
    "system_location",
    "does_design_optimization",
    "does_costs",
    "tags",
]]
cost_df = cost_df[ cost_df["does_costs"] == True]
cost_df.dropna()

ⓘ	scope	system_location	does_design_optimization	does_costs	tags
hopp	[farm, system]	[any]	True	True	[hybrid optimization performance platform, hybrid energy system design, renewable energy policy analysis, system sizing, system cost]
landbosse	[turbine, system]	[any]	True	True	[balance of station, balance of plant, onshore, land-based, logistics, assembly, installation, lcoe]
orbit	[turbine, system]	[any]	True	True	[balance of station, balance of plant, fixed bottom, floating, logistics, assembly, installation, lcoe]
weis	[turbine]	[any]	True	True	[mid-fidelity engineering models, multidisciplinary design optimization, controls co-design]
wisdem	[turbine, system]	[any]	True	True	[low-fidelity conceptual models, multidisciplinary design optimization]
wombat	[turbine, farm, system]	[any]	False	True	[operations and maintenance, discrete event simulation]

Full Suite Modeling Comparison

Show code cell source

Hide code cell source

modeling_df = df[[
    "scope",
    "system_location",
    "time_domain",
    "turbine_model",
    "wake_model",
    "does_controls",
    "does_costs",
    "does_data_analysis",
    "does_design",
    "does_design_optimization",
    "does_simulation",
    "does_loads",
    "tags",
]]
modeling_df

ⓘ	scope	system_location	time_domain	turbine_model	wake_model	does_controls	does_costs	does_data_analysis	does_design	does_design_optimization	does_simulation	does_loads	tags
amr-wind	[turbine, farm, atmosphere]	[any]	dynamic	[actuator, geometry_resolved]	[navier_stokes]	False	False	False	False	False	True	False	[adaptive mesh refinement, massively parallel, block-structured adaptive-mesh, incompressible flow, actuator disk, actuator line, large eddy simulation, les]
dw_tap	[turbine, farm]	[land]	dynamic	[N/A]	[N/A]	False	False	True	False	True	False	False	[distributed wind, obstacle modeling, atmospheric modeling, resource estimation, turbing siting]
dwind	[turbine, farm, system]	[land]	dynamic	[multibody_bem]	[N/A]	False	False	True	False	False	False	False	[distributed wind, distributed futures, technical potential, annualized energy productivity]
erf	[atmosphere]	[any]	dynamic	[momentum_sink, actuator]	[navier_stokes]	False	False	False	False	False	True	False	[adaptive mesh refinement, massively parallel, block-structured adaptive-mesh, moist compressible flow, precipitation, microphysics scheme, planetary boundary layer scheme, real meteorological data initial/boundary conditions]
fastfarm	[farm, turbine, atmosphere]	[any]	dynamic	[multibody_bem, vortex_method]	[dynamic_meandering, vortex_method]	True	False	False	False	False	True	True	[dynamic wake meandering, polar wake, curled wake, wake-added turbulence]
flasc	[turbine, farm, system]	[any]	steady	[lookup_table, SCADA]	[analytical]	False	False	True	False	False	False	False	[steady state analytical engineering models, scada data analysis, filtering, estimation, wind farm visualization, fault detection]
floris	[turbine, farm, system, atmosphere]	[any]	steady	[lookup_table]	[analytical]	True	False	False	False	True	True	False	[steady state, analytical wake model, gaussian wake, engineering model]
hercules	[turbine, farm, atmosphere]	[any]	dynamic	[actuator]	[navier_stokes]	False	False	False	False	False	True	True	[amr-wind, large eddy simulation, wind farm flow control]
hopp	[farm, system]	[any]	dynamic	[regression, lookup_table, multibody_bem]	[analytical]	True	True	False	True	True	True	False	[hybrid optimization performance platform, hybrid energy system design, renewable energy policy analysis, system sizing, system cost]
kynema	[turbine]	[any]	dynamic	[multibody_bem]	[N/A]	False	False	False	False	False	True	True	[geometrically exact beam theory, nonlinear finite elements, GPU, CUDA]
(17 more rows not shown)

Distribution

Show code cell source

Hide code cell source

distribution_df = df[[
    "supported_platforms",
    "package_manager",
    "package_manager_url",
    "installation_complexity",
]]
distribution_df

ⓘ	supported_platforms	package_manager	package_manager_url	installation_complexity
amr-wind	[any]	[spack_manager]	NaN	6.0
dw_tap	[any]	NaN	NaN	5.0
dwind	[any]	NaN	NaN	8.0
erf	[any]	NaN	NaN	NaN
fastfarm	[any]	[homebrew, conda-forge]	[https://formulae.brew.sh/formula/openfast, https://anaconda.org/conda-forge/openfast]	3.0
flasc	[any]	[pypi]	[https://PyPI.org/project/flasc]	1.0
floris	[any]	[pypi, conda-forge]	[https://PyPI.org/project/FLORIS/, https://anaconda.org/conda-forge/floris]	1.0
hercules	[macos]	NaN	NaN	NaN
hopp	[any]	[pypi]	[https://PyPI.org/project/HOPP/]	2.0
kynema	[any]	NaN	NaN	4.0
(17 more rows not shown)

Documentation

Show code cell source

Hide code cell source

documentation_df = df[[
    "documentation_url",
    "has_user_docs",
    "has_developer_docs",
    "has_api_docs",
    "has_cli_docs",
    "has_installation_docs",
    "has_getting_started_docs",
    "has_examples_tutorials",
    "has_design_intent_statement",
    "readability",
    "project_coverage",
]]
documentation_df

ⓘ	documentation_url	has_user_docs	has_developer_docs	has_api_docs	has_cli_docs	has_installation_docs	has_getting_started_docs	has_examples_tutorials	has_design_intent_statement	readability	project_coverage
amr-wind	https://exawind.github.io/amr-wind/	True	True	True	NaN	True	NaN	NaN	NaN	NaN	NaN
dw_tap	https://dw-tap.nlr.gov	True	True	True	False	True	False	False	False	4.0	5.0
dwind	NaN	False	False	False	False	True	False	False	False	2.0	2.0
erf	https://erf.readthedocs.io	True	True	True	NaN	True	True	NaN	True	NaN	9.0
fastfarm	https://openfast.readthedocs.io	True	True	True	True	True	False	False	True	5.0	5.0
flasc	https://flasc.readthedocs.io/en/latest/	True	False	False	False	True	True	True	False	6.0	6.0
floris	https://natlabrockies.github.io/floris/intro.html	True	True	True	False	True	True	True	True	7.0	8.0
hercules	NaN	False	False	False	False	False	False	False	False	NaN	NaN
hopp	https://hopp.readthedocs.io/en/latest/	True	False	False	False	True	False	False	False	5.0	5.0
kynema	https://kynema.github.io/kynema/	False	True	False	False	True	False	False	True	6.0	1.0
(17 more rows not shown)

Testing

Show code cell source

Hide code cell source

testing_df = df[[
    "testing_framework",
    "continuous_testing",
    "test_coverage",
    "test_documentation",
    "performance_tests",
]]
testing_df

ⓘ	testing_framework	continuous_testing	test_coverage	test_documentation	performance_tests
amr-wind	False	True	NaN	True	NaN
dw_tap	False	False	0.0	False	False
dwind	False	False	0.0	False	False
erf	True	True	NaN	NaN	NaN
fastfarm	True	True	20.0	False	False
flasc	True	True	50.0	False	False
floris	True	True	20.0	False	False
hercules	False	False	NaN	False	False
hopp	True	True	50.0	False	False
kynema	True	True	40.0	False	False
(17 more rows not shown)

Interfaces

Show code cell source

Hide code cell source

interfaces_df = df[[
    "first_class_ui",
    "has_cli",
    "language_interfaces",
    "feature_accessibility",
]]
interfaces_df

ⓘ	first_class_ui	has_cli	language_interfaces	feature_accessibility
amr-wind	[input_files]	False	NaN	NaN
dw_tap	[library_interface]	False	[python]	20.0
dwind	[library_interface]	False	[python]	NaN
erf	[input_files]	NaN	NaN	NaN
fastfarm	[input_files]	True	NaN	100.0
flasc	[input_files]	False	NaN	100.0
floris	[input_files]	False	NaN	100.0
hercules	[web]	False	NaN	NaN
hopp	[input_files]	False	NaN	40.0
kynema	NaN	NaN	NaN	NaN
(17 more rows not shown)

Input / Output

Show code cell source

Hide code cell source

io_df = df[[
    "filetypes",
    "file_structure_stability",
]]
io_df

ⓘ	filetypes	file_structure_stability
amr-wind	NaN	NaN
dw_tap	[json, csv, custom]	in_development
dwind	[custom]	in_development
erf	[custom]	stable
fastfarm	[custom]	semantic_versioning
flasc	[yaml]	semantic_versioning
floris	[yaml]	semantic_versioning
hercules	NaN	NaN
hopp	[yaml]	in_development
kynema	NaN	NaN
(17 more rows not shown)