Demonstration of the Available Metrics

For a complete list of metrics and their documentation, please see the API Metrics documentation.

This demonstration will rely on the results produced in the "How To" notebook and serves as an extension of the API documentation to show what the results will look like depending on what inputs are provided.

A Jupyter notebook of this tutorial can be run from examples/metrics_demonstration.ipynb locally, or through binder.

from pprint import pprint
from functools import partial

import pandas as pd
from pandas.io.formats.style import Styler

from wombat.core import Simulation, Metrics
from wombat.utilities import plot

# Clean up the aesthetics for the pandas outputs
pd.set_option("display.max_rows", 30)
pd.set_option("display.max_columns", 10)
style = partial(
  Styler,
  table_attributes='style="font-size: 14px; grid-column-count: 6"',
  precision=2,
  thousands=",",
)

Table of Contents

Below is a list of top-level sections to demonstrate how to use WOMBAT's Metrics class methods and an explanation of each individual metric.

If you don't see a metric or result computation that is core to your work, please submit an issue with details on what the metric is, and how it should be computed.

• Setup: Running a simulation to gather the results

• Common Parameters: Explanation of frequently used parameter settings

• Availability: Time-based and energy-based availability

• Capacity Factor: Gross and net capacity factor

• Task Completion Rate: Task completion metrics

• Equipment Costs: Cost breakdowns by servicing equipment

• Service Equipment Utilization Rate: Utilization of servicing equipment

• Vessel-Crew Hours at Sea: Number of crew or vessel hours spent at sea

• Number of Tows: Number of tows breakdowns

• Dispatch Summary: Mobilization and charter period breakdown

• Labor Costs: Breakdown of labor costs

• Equipment and Labor Costs: Combined servicing equipment and labor cost breakdown

• Emissions: Emissions of servicing equipment based on activity

• Component Costs: Materials costs

• Fixed Cost Impacts: Total fixed costs

• OpEx: Project OpEx

• Process Times: Timing of various stages of repair and maintenance

• Request Summary: Total number of submitted, canceled, and completed repair and maintenance tasks

• Power Production: Energy production, in GWh, MWh, or kWh

• H2 Production: Produced Hydrogen, in kg/hr or t/hr

• Net Present Value: Project NPV calculator

Setup

The simulations from the How To notebook are going to be rerun as it is not recommended to create a Metrics class from scratch due to the large number of inputs that are required, and the initialization is provided in the simulation API's run method.

To simplify this process, a feature has been added to save the simulation outputs required to generate the Metrics inputs and a method to reload those outputs as inputs.

sim = Simulation("COREWIND", "morro_bay_in_situ.yaml")

# Both of these parameters are True by default for convenience
sim.run(create_metrics=True, save_metrics_inputs=True)

# Load the metrics data
fpath = sim.env.metrics_input_fname.parent
fname = sim.env.metrics_input_fname.name
metrics = Metrics.from_simulation_outputs(fpath, fname)

# Delete the log files now that they're loaded in
sim.env.cleanup_log_files()

# Alternatively, in this case because the simulation was run, we can use the
# following for convenience convenience only
metrics = sim.metrics

Common Parameter Explanations

Before diving into each and every metric, and how they can be customized, it is worth noting some of the most common parameters used throughout, and their meanings to reduce redundancy. The varying output forms are demonstrated in the availability section below.

frequency

project

Computed across the whole simulation, with the resulting DataFrame having an empty index.

annual

Summary of each year in the simulation, with the resulting DataFrame having "year" as the index.

monthly

Summary of each month of the year, aggregated across years, with the resulting DataFrame having "month" as the index.

month-year

computed on a month-by-year basis, producing the results for every month of the simulation, with the resulting DataFrame having "year" and "month" as the index.

by

windfarm

Aggregated across all turbines, with the resulting DataFrame having only "windfarm" as a column.

turbine

Computed for each turbine, with the resulting DataFrame having a column for each turbine.

electrolyzer

Computed for each electrolyzer, with the resulting DataFrame having a column for each electrolyzer. This option is only available for the availability and capacity factor metrics.

Availability

There are two methods to produce availability, which have their own function calls:

• energy: actual power produced divided by potential power produced

  • wombat.core.post_processor.Metrics.production_based_availability()

• time: The ratio of all non-zero hours to all hours in the simulation, or the proportion of the simulation where turbines are operating

  • wombat.core.post_processor.Metrics.time_based_availability()

Here, we will go through the various input definitions to get time-based availability data as both methods use the same inputs, and provide outputs in the same format.

Inputs:

• frequency, as explained above options: "project", "annual", "monthly", and "month-year"

• by, as explained above options: "windfarm", "turbine", or "electrolyzer"

Below is a demonstration of the variations on frequency and by for time_based_availability.

style(metrics.time_based_availability(frequency="project", by="windfarm"))

	windfarm
time_availability	0.91

style(metrics.production_based_availability(frequency="project", by="windfarm"))

	windfarm
energy_availability	0.91

Note that in the two above examples, that the values are equal. This is due to the fact that the example simulation does not have any operating reduction applied to failures, unless it's a catastrophic failure, so there is no expected difference.

# Demonstrate the by turbine granularity
style(metrics.time_based_availability(frequency="project", by="turbine"))

	WTG_0000	WTG_0001	WTG_0002	WTG_0003	WTG_0004	WTG_0005	WTG_0006	WTG_0007	WTG_0008	WTG_0009	WTG_0100	WTG_0101	WTG_0102	WTG_0103	WTG_0104	WTG_0105	WTG_0106	WTG_0107	WTG_0108	WTG_0109	WTG_0200	WTG_0201	WTG_0202	WTG_0203	WTG_0204	WTG_0205	WTG_0206	WTG_0207	WTG_0208	WTG_0209	WTG_0300	WTG_0301	WTG_0302	WTG_0303	WTG_0304	WTG_0305	WTG_0306	WTG_0307	WTG_0308	WTG_0309	WTG_0400	WTG_0401	WTG_0402	WTG_0403	WTG_0404	WTG_0405	WTG_0406	WTG_0407	WTG_0408	WTG_0409	WTG_0500	WTG_0501	WTG_0502	WTG_0503	WTG_0504	WTG_0505	WTG_0506	WTG_0507	WTG_0508	WTG_0509	WTG_0600	WTG_0601	WTG_0602	WTG_0603	WTG_0604	WTG_0605	WTG_0606	WTG_0607	WTG_0608	WTG_0609	WTG_0700	WTG_0701	WTG_0702	WTG_0703	WTG_0704	WTG_0705	WTG_0706	WTG_0707	WTG_0708	WTG_0709
time_availability	0.91	0.91	0.92	0.89	0.90	0.91	0.92	0.91	0.90	0.93	0.90	0.90	0.91	0.90	0.92	0.92	0.90	0.91	0.91	0.91	0.91	0.92	0.91	0.91	0.92	0.92	0.92	0.90	0.91	0.91	0.90	0.90	0.89	0.91	0.90	0.88	0.92	0.90	0.91	0.91	0.89	0.90	0.91	0.89	0.92	0.91	0.90	0.90	0.91	0.90	0.90	0.91	0.92	0.92	0.91	0.92	0.90	0.91	0.92	0.91	0.91	0.91	0.90	0.92	0.91	0.91	0.91	0.90	0.91	0.91	0.90	0.91	0.91	0.92	0.92	0.91	0.92	0.92	0.91	0.89

# Demonstrate the annualized outputs
style(metrics.time_based_availability(frequency="annual", by="windfarm"))

	windfarm
year
2002	0.95
2003	0.88
2004	0.91
2005	0.90
2006	0.91
2007	0.86
2008	0.92
2009	0.92
2010	0.89
2011	0.88
2012	0.91
2013	0.92
2014	0.91
2015	0.93
2016	0.91
2017	0.91
2018	0.92
2019	0.90
2020	0.92
2021	0.91

# Demonstrate the month aggregations
style(metrics.time_based_availability(frequency="monthly", by="windfarm"))

	windfarm
month
1	0.87
2	0.86
3	0.88
4	0.86
5	0.88
6	0.91
7	0.93
8	0.95
9	0.95
10	0.94
11	0.93
12	0.93

# Demonstrate the granular monthly reporting
style(metrics.time_based_availability(frequency="month-year", by="windfarm"))

		windfarm
year	month
2002	1	0.93
	2	0.93
	3	0.96
	4	0.96
	5	0.95
	6	0.93
	7	0.97
	8	0.97
	9	0.98
	10	0.97
	11	0.93
	12	0.96
2003	1	0.37
	2	0.91
	3	0.90
	4	0.90
	5	0.90
	6	0.90
	7	0.91
	8	0.96
	9	0.98
	10	0.93
	11	0.97
	12	0.92
2004	1	0.73
	2	0.90
	3	0.90
	4	0.90
	5	0.90
	6	0.90
	7	0.94
	8	0.96
	9	0.95
	10	0.97
	11	0.96
	12	0.92
2005	1	0.73
	2	0.81
	3	0.89
	4	0.89
	5	0.90
	6	0.90
	7	0.93
	8	0.98
	9	0.97
	10	0.93
	11	0.96
	12	0.95
2006	1	0.90
	2	0.73
	3	0.90
	4	0.90
	5	0.90
	6	0.89
	7	0.90
	8	0.93
	9	0.96
	10	0.97
	11	0.96
	12	0.92
2007	1	0.91
	2	0.32
	3	0.85
	4	0.91
	5	0.90
	6	0.90
	7	0.90
	8	0.91
	9	0.96
	10	0.96
	11	0.87
	12	0.93
2008	1	0.94
	2	0.90
	3	0.85
	4	0.95
	5	0.90
	6	0.90
	7	0.90
	8	0.90
	9	0.96
	10	0.96
	11	0.95
	12	0.95
2009	1	0.95
	2	0.93
	3	0.83
	4	0.90
	5	0.93
	6	0.93
	7	0.90
	8	0.95
	9	0.93
	10	0.92
	11	0.93
	12	0.94
2010	1	0.92
	2	0.90
	3	0.75
	4	0.67
	5	0.95
	6	0.91
	7	0.90
	8	0.94
	9	0.92
	10	0.93
	11	0.91
	12	0.95
2011	1	0.95
	2	0.92
	3	0.70
	4	0.70
	5	0.90
	6	0.93
	7	0.93
	8	0.91
	9	0.92
	10	0.93
	11	0.92
	12	0.89
2012	1	0.92
	2	0.92
	3	0.93
	4	0.77
	5	0.93
	6	0.91
	7	0.96
	8	0.92
	9	0.93
	10	0.94
	11	0.91
	12	0.89
2013	1	0.90
	2	0.90
	3	0.92
	4	0.77
	5	0.96
	6	0.92
	7	0.96
	8	0.95
	9	0.93
	10	0.91
	11	0.96
	12	0.95
2014	1	0.92
	2	0.94
	3	0.94
	4	0.68
	5	0.94
	6	0.90
	7	0.97
	8	0.96
	9	0.94
	10	0.91
	11	0.91
	12	0.90
2015	1	0.93
	2	0.94
	3	0.95
	4	0.90
	5	0.82
	6	0.95
	7	0.98
	8	0.98
	9	0.95
	10	0.95
	11	0.90
	12	0.90
2016	1	0.91
	2	0.89
	3	0.89
	4	0.90
	5	0.81
	6	0.92
	7	0.95
	8	0.98
	9	0.94
	10	0.92
	11	0.88
	12	0.89
2017	1	0.89
	2	0.89
	3	0.90
	4	0.90
	5	0.74
	6	0.90
	7	0.90
	8	0.96
	9	0.96
	10	0.92
	11	0.96
	12	0.94
2018	1	0.92
	2	0.91
	3	0.90
	4	0.91
	5	0.85
	6	0.92
	7	0.94
	8	0.96
	9	0.96
	10	0.96
	11	0.93
	12	0.91
2019	1	0.90
	2	0.90
	3	0.89
	4	0.90
	5	0.65
	6	0.86
	7	0.95
	8	0.96
	9	0.96
	10	0.97
	11	0.94
	12	0.90
2020	1	0.90
	2	0.90
	3	0.90
	4	0.89
	5	0.81
	6	0.92
	7	0.94
	8	0.97
	9	0.96
	10	0.96
	11	0.95
	12	0.93
2021	1	0.89
	2	0.80
	3	0.89
	4	0.90
	5	0.90
	6	0.84
	7	0.90
	8	0.94
	9	0.96
	10	0.93
	11	0.95
	12	0.96

Plotting Availability

As of v0.9, the ability to plot the wind farm and turbine availability has been enabled as an experimental feature. Please see the plotting API documentation for more details.

# Demonstrate the granular monthly reporting
plot.plot_farm_availability(sim=sim, which="energy", farm_95_CI=True)

Capacity Factor

The capacity factor is the ratio of actual (net) or potential (gross) energy production divided by the project's capacity. For further documentation, see the API docs here: wombat.core.post_processor.Metrics.capacity_factor().

Inputs:

• which

  • "net": net capacity factor, actual production divided by the plant capacity

  • "gross": gross capacity factor, potential production divided by the plant capacity

• frequency, as explained above, options: "project", "annual", "monthly", and "month-year"

• by, as explained above, options: "windfarm", "turbine", and "electrolyzer"

Example Usage:

net_cf = metrics.capacity_factor(which="net", frequency="project", by="windfarm").squeeze()
gross_cf = metrics.capacity_factor(which="gross", frequency="project", by="windfarm").squeeze()
print(f"  Net capacity factor: {net_cf:.2%}")
print(f"Gross capacity factor: {gross_cf:.2%}")

  Net capacity factor: 50.41%
Gross capacity factor: 55.59%

Task Completion Rate

The task completion rate is the ratio of tasks completed aggregated to the desired frequency. It is possible to have a >100% completion rate if all maintenance and failure requests submitted in a time period were completed in addition to those that went unfinished in prior time periods. For further documentation, see the API docs here: wombat.core.post_processor.Metrics.task_completion_rate().

Inputs:

• which

  • "scheduled": scheduled maintenance only (classified as maintenance tasks in inputs)

  • "unscheduled": unscheduled maintenance only (classified as failure events in inputs)

  • "both": Combined completion rate for all tasks

• frequency, as explained above, options: "project", "annual", "monthly", and "month-year"

Example Usage:

scheduled = metrics.task_completion_rate(which="scheduled", frequency="project").values[0][0]
unscheduled = metrics.task_completion_rate(which="unscheduled", frequency="project").values[0][0]
combined = metrics.task_completion_rate(which="both", frequency="project").values[0][0]
print(f"  Scheduled Task Completion Rate: {scheduled:.2%}")
print(f"Unscheduled Task Completion Rate: {unscheduled:.2%}")
print(f"    Overall Task Completion Rate: {combined:.2%}")

  Scheduled Task Completion Rate: 95.97%
Unscheduled Task Completion Rate: 95.49%
    Overall Task Completion Rate: 95.67%

Equipment Costs

Sum of the costs associated with a simulation's servicing equipment, which excludes materials, downtime, etc. For further documentation, see the API docs here: wombat.core.post_processor.Metrics.equipment_costs().

Inputs:

• frequency, as explained above, options: "project", "annual", "monthly", and "month-year"

• by_equipment

  • True: Aggregates all equipment into a single cost

  • False: Computes for each unit of servicing equipment

Example Usage:

# Project total at the whole wind farm level
style(metrics.equipment_costs(frequency="project", by_equipment=False))

	equipment_cost
0	2,306,302,247.26

# Project totals at servicing equipment level
style(metrics.equipment_costs(frequency="project", by_equipment=True))

	Anchor Handling Tug	Cable Laying Vessel	Crew Transfer Vessel 1	Crew Transfer Vessel 2	Crew Transfer Vessel 3	Crew Transfer Vessel 4	Crew Transfer Vessel 5	Crew Transfer Vessel 6	Crew Transfer Vessel 7	Diving Support Vessel	Heavy Lift Vessel
0	112,002,687.56	161,983,275.31	25,563,198.90	25,563,192.29	25,563,192.03	25,563,209.39	25,563,195.15	25,563,192.36	25,563,185.45	117,367,627.58	1,736,006,291.24

Service Equipment Utilization Rate

Ratio of days when the servicing equipment is in use (not delayed for a whole day due to either weather or lack of repairs to be completed) to the number of days it's present in the simulation. For further documentation, see the API docs here: wombat.core.post_processor.Metrics.service_equipment_utilization().

Inputs:

• frequency, as explained above, options: "project" and "annual"

Example Usage:

# Project totals
style(metrics.service_equipment_utilization(frequency="project"))

	Anchor Handling Tug	Cable Laying Vessel	Crew Transfer Vessel 1	Crew Transfer Vessel 2	Crew Transfer Vessel 3	Crew Transfer Vessel 4	Crew Transfer Vessel 5	Crew Transfer Vessel 6	Crew Transfer Vessel 7	Diving Support Vessel	Heavy Lift Vessel
0	0.86	0.93	1.00	1.00	1.00	1.00	1.00	1.00	1.00	0.96	1.00

Vessel-Crew Hours at Sea

The number of vessel hours or crew hours at sea for offshore wind power plant simulations. For further documentation, see the API docs here: wombat.core.post_processor.Metrics.vessel_crew_hours_at_sea().

Inputs:

• frequency, as explained above, options: "project", "annual", "monthly", and "month-year"

• by_equipment

  • True: Aggregates all equipment into a single cost

  • False: Computes for each unit of servicing equipment

• vessel_crew_assumption: A dictionary of vessel names (ServiceEquipment.settings.name, but also found at Metrics.service_equipment_names) and the number of crew onboard at any given time. The application of this assumption transforms the results from vessel hours at sea to crew hours at sea.

Example Usage:

# Project total, not broken out by vessel
style(metrics.vessel_crew_hours_at_sea(frequency="project", by_equipment=False))

	Total Crew Hours at Sea
0	672,220.33

# Annual project totals, broken out by vessel
style(metrics.vessel_crew_hours_at_sea(frequency="annual", by_equipment=True))

---------------------------------------------------------------------------
KeyError                                  Traceback (most recent call last)
Cell In[16], line 2
      1 # Annual project totals, broken out by vessel
----> 2 style(metrics.vessel_crew_hours_at_sea(frequency="annual", by_equipment=True))

File /opt/hostedtoolcache/Python/3.11.13/x64/lib/python3.11/site-packages/wombat/core/post_processor.py:1030, in Metrics.vessel_crew_hours_at_sea(self, frequency, by_equipment, vessel_crew_assumption)
   1024         return pd.DataFrame(at_sea.sum()[["duration"]]).T.rename(
   1025             columns={"duration": "Total Crew Hours at Sea"}
   1026         )
   1027 additional_cols = frequency.group_cols
   1028 total_hours = (
   1029     total_hours.drop(columns=frequency.drop_cols)
-> 1030     .groupby(group_cols)[["N"]]
   1031     .sum()
   1032 )
   1034 columns = additional_cols + columns
   1035 group_cols.extend(additional_cols)

File /opt/hostedtoolcache/Python/3.11.13/x64/lib/python3.11/site-packages/pandas/core/frame.py:9190, in DataFrame.groupby(self, by, axis, level, as_index, sort, group_keys, observed, dropna)
   9187 if level is None and by is None:
   9188     raise TypeError("You have to supply one of 'by' and 'level'")
-> 9190 return DataFrameGroupBy(
   9191     obj=self,
   9192     keys=by,
   9193     axis=axis,
   9194     level=level,
   9195     as_index=as_index,
   9196     sort=sort,
   9197     group_keys=group_keys,
   9198     observed=observed,
   9199     dropna=dropna,
   9200 )

File /opt/hostedtoolcache/Python/3.11.13/x64/lib/python3.11/site-packages/pandas/core/groupby/groupby.py:1330, in GroupBy.__init__(self, obj, keys, axis, level, grouper, exclusions, selection, as_index, sort, group_keys, observed, dropna)
   1327 self.dropna = dropna
   1329 if grouper is None:
-> 1330     grouper, exclusions, obj = get_grouper(
   1331         obj,
   1332         keys,
   1333         axis=axis,
   1334         level=level,
   1335         sort=sort,
   1336         observed=False if observed is lib.no_default else observed,
   1337         dropna=self.dropna,
   1338     )
   1340 if observed is lib.no_default:
   1341     if any(ping._passed_categorical for ping in grouper.groupings):

File /opt/hostedtoolcache/Python/3.11.13/x64/lib/python3.11/site-packages/pandas/core/groupby/grouper.py:1043, in get_grouper(obj, key, axis, level, sort, observed, validate, dropna)
   1041         in_axis, level, gpr = False, gpr, None
   1042     else:
-> 1043         raise KeyError(gpr)
   1044 elif isinstance(gpr, Grouper) and gpr.key is not None:
   1045     # Add key to exclusions
   1046     exclusions.add(gpr.key)

KeyError: 'agent'

Number of Tows

The number of tows performed during the simulation. If tow-to-port was not used in the simulation, a DataFrame with a single value of 0 will be returned. For further documentation, see the API docs here: wombat.core.post_processor.Metrics.number_of_tows().

Inputs:

• frequency, as explained above, options: "project", "annual", "monthly", and "month-year"

• by_tug

  • True: Computed for each tugboat (towing vessel)

  • False: Aggregates all the tugboats

• by_direction

  • True: Computed for each direction a tow was performed (to port or to site)

  • False: Aggregates to the total number of tows

Example Usage:

# Project Total
# NOTE: This example has no towing, so it will return 0
style(metrics.number_of_tows(frequency="project"))

	total_tows
0	0

Dispatch Summary

The number of mobilizations and the average length of their charter during the simulation for each piece of servicing equipment. For further documentation, see the API docs here: wombat.core.post_processor.Metrics.dispatch_summary().

Inputs:

• frequency, as explained above, options: "project", "annual", "monthly", and "month-year"

Example Usage:

# Project Total
style(metrics.dispatch_summary(frequency="project"))

	N Mobilizations	Average Charter Days
agent
Anchor Handling Tug	52	24.60
Cable Laying Vessel	42	48.42
Crew Transfer Vessel 1	1	7,303.00
Crew Transfer Vessel 2	1	7,303.67
Crew Transfer Vessel 3	1	7,303.67
Crew Transfer Vessel 4	1	7,303.00
Crew Transfer Vessel 5	1	7,303.00
Crew Transfer Vessel 6	1	7,303.00
Crew Transfer Vessel 7	1	7,303.67
Diving Support Vessel	155	7.03
Heavy Lift Vessel	144	40.26

Labor Costs

Sum of all labor costs associated with servicing equipment, excluding the labor defined in the fixed costs, which can be broken out by type. For further documentation, see the API docs here: wombat.core.post_processor.Metrics.labor_costs().

Inputs:

• frequency, as explained above, options: "project", "annual", "monthly", and "month-year"

• by_type

  • True: Computed for each labor type (salary and hourly)

  • False: Aggregates all the labor costs

Example Usage:

# Project total at the whole wind farm level
total = metrics.labor_costs(frequency="project", by_type=False)
print(f"Project total: ${total.values[0][0] / metrics.project_capacity:,.2f}/MW")

Project total: $41,388.30/MW

# Project totals for each type of labor
style(metrics.labor_costs(frequency="project", by_type=True))

	hourly_labor_cost	salary_labor_cost	total_labor_cost
0	0.00	49,665,957.22	49,665,957.22

Equipment and Labor Costs

Sum of all labor and servicing equipment costs, excluding the labor defined in the fixed costs, which can be broken out by each category. For further documentation, see the API docs here: wombat.core.post_processor.Metrics.equipment_labor_cost_breakdown().

Inputs:

• frequency, as explained above, options: "project", "annual", "monthly", and "month-year"

• by_category

  • True: Computed for each unit servicing equipment and labor category

  • False: Aggregated to the sum of all costs

reason definitions:

• Maintenance: routine maintenance, or events defined as a wombat.core.data_classes.Maintenance

• Repair: unscheduled maintenance, ranging from inspections to replacements, or events defined as a wombat.core.data_classes.Failure

• Mobilization: Cost of mobilizing servicing equipment

• Crew Transfer: Costs incurred while crew are transferring between a turbine or substation and the servicing equipment

• Site Travel: Costs incurred while transiting to/from the site and while at the site

• Weather Delay: Any delays caused by unsafe weather conditions

• No Requests: Equipment and labor is active, but there are no repairs or maintenance tasks to be completed

• Not in Shift: Any time outside the operating hours of the wind farm (or the servicing equipment's specific operating hours)

Example Usage:

# Project totals
style(metrics.equipment_labor_cost_breakdowns(frequency="project", by_category=False))

	total_cost	total_hours
reason
Maintenance	23,834,262.80	73,352.59
Repair	599,420,627.18	162,726.41
Crew Transfer	8,772,317.22	11,248.75
Site Travel	96,460,539.36	123,638.56
Mobilization	119,235,000.00	130,512.00
Weather Delay	1,406,606,866.01	602,062.06
No Requests	73,131,604.92	392,650.55
Not in Shift	28,506,986.99	107,176.66

# Project totals by each category
style(metrics.equipment_labor_cost_breakdowns(frequency="project", by_category=True))

	hourly_labor_cost	salary_labor_cost	total_labor_cost	equipment_cost	total_cost	total_hours
reason
Maintenance	0	2,243,433.81	2,243,433.81	21,590,828.99	23,834,262.80	73,352.59
Repair	0	7,583,230.59	7,583,230.59	591,837,396.59	599,420,627.18	162,726.41
Crew Transfer	0	352,176.60	352,176.60	8,420,140.62	8,772,317.22	11,248.75
Site Travel	0	3,898,290.33	3,898,290.33	92,562,249.03	96,460,539.36	123,638.56
Mobilization	0	0.00	0.00	119,235,000.00	119,235,000.00	130,512.00
Weather Delay	0	21,635,885.83	21,635,885.83	1,384,970,980.18	1,406,606,866.01	602,062.06
No Requests	0	10,868,262.79	10,868,262.79	62,263,342.13	73,131,604.92	392,650.55
Not in Shift	0	3,084,677.28	3,084,677.28	25,422,309.71	28,506,986.99	107,176.66

Emissions

Emissions (tons or other provided units) of all servicing equipment activity, except overnight waiting periods between shifts. For further documentation, see the API docs here: wombat.core.post_processor.Metrics.emissions().

Inputs:

• emissions_factors: Dictionary of servicing equipment names and the emissions per hour of the following activities: transit, maneuvering, idle at site, and idle at port, where port is stand-in for wherever the servicing equipment might be based when not at site.

• maneuvering_factor: The proportion of transit time that can generally be associated with positioning servicing, by default 10%.

• port_engine_on_factor: The proportion of the idling at port time when the engine is running and producing emissions, by default 25%.

# Create the emissions factors, in tons per hour
emissions_factors = {
    "Crew Transfer Vessel 1": {
        "transit": 4,
        "maneuvering": 3,
        "idle at site": 0.5,
        "idle at port": 0.25,
    },
    "Field Support Vessel": {
        "transit": 6,
        "maneuvering": 4,
        "idle at site": 1,
        "idle at port": 0.5,
    },
    "Heavy Lift Vessel": {
        "transit": 12,
        "maneuvering": 7,
        "idle at site": 1,
        "idle at port": 0.5,
    },
    "Diving Support Vessel": {
        "transit": 4,
        "maneuvering": 7,
        "idle at site": 0.2,
        "idle at port": 0.2,
    },
    "Cable Laying Vessel": {
        "transit": 4,
        "maneuvering": 7,
        "idle at site": 0.2,
        "idle at port": 0.2,
    },
    "Anchor Handling Tug": {
        "transit": 4,
        "maneuvering": 3,
        "idle at site": 1,
        "idle at port": 0.25,
    },
}

# Add in CTVs 2 through 7
for i in range(2, 8):
    emissions_factors[f"Crew Transfer Vessel {i}"] = emissions_factors[f"Crew Transfer Vessel 1"]

style(metrics.emissions(emissions_factors=emissions_factors, maneuvering_factor=0.075, port_engine_on_factor=0.20))

		duration	distance_km	emissions
agent	category
Anchor Handling Tug	idle at port	4,737.09	0.00	1,184.27
	idle at site	29,339.65	0.00	29,339.65
	maneuvering	1,920.44	0.00	5,761.33
	transit	23,685.47	inf	94,741.89
Cable Laying Vessel	idle at port	2,789.50	0.00	557.90
	idle at site	41,444.79	0.00	8,288.96
	maneuvering	1,130.88	0.00	7,916.16
	transit	13,947.51	inf	55,790.06
Crew Transfer Vessel 1	idle at port	3,062.25	0.00	765.56
	idle at site	32,039.81	0.00	16,019.90
	maneuvering	1,241.45	0.00	3,724.36
	transit	15,311.24	inf	61,244.97
Crew Transfer Vessel 2	idle at port	3,055.82	0.00	763.95
	idle at site	31,614.73	0.00	15,807.37
	maneuvering	1,238.84	0.00	3,716.53
	transit	15,279.08	inf	61,116.33
Crew Transfer Vessel 3	idle at port	3,056.77	0.00	764.19
	idle at site	31,640.40	0.00	15,820.20
	maneuvering	1,239.23	0.00	3,717.69
	transit	15,283.83	inf	61,135.33
Crew Transfer Vessel 4	idle at port	3,132.65	0.00	783.16
	idle at site	33,046.35	0.00	16,523.18
	maneuvering	1,269.99	0.00	3,809.98
	transit	15,663.26	inf	62,653.05
Crew Transfer Vessel 5	idle at port	3,065.78	0.00	766.45
	idle at site	31,851.72	0.00	15,925.86
	maneuvering	1,242.88	0.00	3,728.65
	transit	15,328.91	inf	61,315.64
Crew Transfer Vessel 6	idle at port	3,025.25	0.00	756.31
	idle at site	31,792.95	0.00	15,896.48
	maneuvering	1,226.45	0.00	3,679.35
	transit	15,126.23	inf	60,504.90
Crew Transfer Vessel 7	idle at port	3,029.56	0.00	757.39
	idle at site	31,780.62	0.00	15,890.31
	maneuvering	1,228.20	0.00	3,684.60
	transit	15,147.81	inf	60,591.25
Diving Support Vessel	idle at port	11,416.50	0.00	2,283.30
	idle at site	5,465.94	0.00	1,093.19
	maneuvering	4,628.31	0.00	32,398.16
	transit	57,082.48	123,562.80	228,329.92
Field Support Vessel	idle at port	0.00	0.00	0.00
	idle at site	0.00	0.00	0.00
	maneuvering	0.00	0.00	0.00
	transit	0.00	0.00	0.00
Heavy Lift Vessel	idle at port	7,285.46	0.00	3,642.73
	idle at site	114,390.00	0.00	114,390.00
	maneuvering	2,953.56	0.00	20,674.94
	transit	36,427.28	inf	437,127.32

Component Costs

All the costs associated with maintenance and failure events during the simulation, including delays incurred during the repair process, but excluding costs not directly tied to a repair. For further documentation, see the API docs here: wombat.core.post_processor.Metrics.component_costs().

Inputs:

• frequency, as explained above, options: "project", "annual", "monthly", and "month-year"

• by_category

  • True: Computed across each subassembly

  • False: (default) Aggregated to the sum of all subassemblies

• by_action

  • True: Computed by each of "repair", "maintenance", and "delay", and is included in the MultiIndex

  • False: (default) Aggregated as the sum of all actions

• by_task

  • True: Computed by each repair and maintenance task for each subassembly

  • False: (default) Aggregated as the sum of all tasks

• include_travel

  • True: Include intrasite and port-to-site travel costs in the repair summary.

  • False: (default) Exclude travel from the cost summary

action definitions:

• maintenance: routine maintenance

• repair: unscheduled maintenance, ranging from inspections to replacements

• delay: Any delays caused by unsafe weather conditions or not being able to finish a process within a single shift

• travel: Any travel to and from the site between shifts or traveling to the system for initial repair, including crew transfer time.

Example Usage:

# Project totals by component
style(metrics.component_costs(frequency="project", by_category=False, by_action=False))

	total_cost
subassembly
anchor	53,693,404.75
array cable	158,644,154.54
ballast pump	68,522.80
drive_train	142,147,309.73
electrical system	27,904,451.90
export cable	6,619,774.94
generator	308,467,360.04
hydraulic pitch system	29,979,216.62
mooring lines	56,746,049.55
power converter	1,119,252,157.93
rotor_blades	102,164,535.59
supporting_structure	80,554,455.01
transformer	1,157,239.70
yaw_system	25,180,860.31

# Project totals by each category and action type
style(metrics.component_costs(frequency="project", by_category=True, by_action=True))

		materials_cost	total_labor_cost	equipment_cost	total_cost
subassembly	action
anchor	delay	0	472,863.75	14,238,985.00	14,711,848.75
	repair	10,341,000	920,556.00	27,720,000.00	38,981,556.00
array cable	delay	0	2,732,050.60	93,486,538.30	96,218,588.90
	repair	6,080,000	1,599,887.69	54,745,677.95	62,425,565.64
ballast pump	delay	0	4,799.92	25,549.34	30,349.26
	repair	16,000	3,506.88	18,666.67	38,173.55
drive_train	delay	0	841,633.67	99,514,368.93	100,356,002.60
	repair	4,499,000	236,411.53	37,055,895.60	41,791,307.13
electrical system	delay	0	710,946.25	19,846,770.82	20,557,717.07
	repair	697,000	168,656.94	6,481,077.89	7,346,734.84
export cable	delay	0	167,981.52	5,748,067.22	5,916,048.74
	maintenance	9,000	19,726.20	675,000.00	703,726.20
generator	delay	0	4,924,789.14	212,577,226.12	217,502,015.26
	maintenance	2,139,000	937,652.04	4,991,000.00	8,067,652.04
	repair	5,881,500	565,663.46	76,450,529.28	82,897,692.74
hydraulic pitch system	delay	0	3,125,142.72	19,594,798.18	22,719,940.91
	repair	1,067,100	838,884.05	5,353,291.67	7,259,275.72
mooring lines	delay	0	1,254,214.14	17,148,818.63	18,403,032.78
	repair	7,740,500	1,187,941.50	29,414,575.28	38,343,016.77
power converter	delay	0	4,188,741.82	790,332,139.97	794,520,881.78
	repair	8,373,000	1,499,779.43	314,858,496.71	324,731,276.14
rotor_blades	delay	0	1,686,401.99	64,194,186.44	65,880,588.43
	repair	6,004,248	451,949.16	29,827,750.00	36,283,947.16
supporting_structure	delay	0	4,081,010.32	58,270,046.65	62,351,056.97
	maintenance	1,150,500	1,261,069.05	15,791,828.99	18,203,398.04
transformer	delay	0	151,162.45	804,618.10	955,780.56
	maintenance	19,000	24,986.52	133,000.00	176,986.52
	repair	12,000	1,972.62	10,500.00	24,472.62
yaw_system	delay	0	376,990.61	14,601,412.84	14,978,403.45
	repair	193,500	108,021.33	9,900,935.53	10,202,456.86

Fixed Cost Impacts

Computes the total costs of the fixed costs categories. For further documentation, see the definition docs, here: wombat.core.data_classes.FixedCosts, or the API docs here: wombat.core.post_processor.Metrics.fixed_costs().

Inputs:

• frequency, as explained above, options: "project", "annual", "monthly", and "month-year"

• resolution (also, demonstrated below)

  • "high": Computed across the most granular cost levels

  • "medium": Computed for each general cost category

  • "low": Aggregated to a single sum of costs

pprint(metrics.fixed_costs.hierarchy)

{'operations': {'annual_leases_fees': ['submerge_land_lease_costs',
                                       'transmission_charges_rights'],
                'environmental_health_safety_monitoring': [],
                'insurance': ['brokers_fee',
                              'operations_all_risk',
                              'business_interruption',
                              'third_party_liability',
                              'storm_coverage'],
                'labor': [],
                'onshore_electrical_maintenance': [],
                'operating_facilities': [],
                'operations_management_administration': ['project_management_administration',
                                                         'marine_management',
                                                         'weather_forecasting',
                                                         'condition_monitoring']}}

Example Usage:

# Project totals at the highest level
# NOTE: there were no fixed costs defined in this example, so all values will be 0, so
#       this will just be demonstrating the output format
style(metrics.project_fixed_costs(frequency="project", resolution="low"))

	operations
0	0.00

# Project totals at the medium level
style(metrics.project_fixed_costs(frequency="project", resolution="medium"))

	operations_management_administration	insurance	annual_leases_fees	operating_facilities	environmental_health_safety_monitoring	onshore_electrical_maintenance	labor
0	0.00	0.00	0.00	0.00	0.00	0.00	0.00

# Project totals at the lowest level
style(metrics.project_fixed_costs(frequency="project", resolution="high"))

	project_management_administration	marine_management	weather_forecasting	condition_monitoring	brokers_fee	operations_all_risk	business_interruption	third_party_liability	storm_coverage	submerge_land_lease_costs	transmission_charges_rights	operating_facilities	environmental_health_safety_monitoring	onshore_electrical_maintenance	labor
0	0.00	0.00	0.00	0.00	0.00	0.00	0.00	0.00	0.00	0.00	0.00	0.00	0.00	0.00	0.00

OpEx

Computes the total cost of all operating expenditures for the duration of the simulation, including fixed costs. For further documentation, see the API docs here: wombat.core.post_processor.Metrics.opex().

Inputs:

• frequency, as explained above, options: "project", "annual", "monthly", and "month-year"

• by_category

  • True shows the port fees, fixed costs, labor costs, equipment costs, and materials costs in addition the total OpEx

  • False shows only the total OpEx

Example Usage:

style(metrics.opex("annual"))

	OpEx
year
2002	113,402,801.04
2003	111,932,253.40
2004	124,336,904.07
2005	116,375,527.63
2006	129,739,410.52
2007	109,237,485.70
2008	128,840,657.23
2009	121,890,072.54
2010	116,612,203.74
2011	127,934,703.05
2012	136,456,854.57
2013	121,377,044.17
2014	120,188,380.58
2015	116,279,385.75
2016	117,401,339.42
2017	118,560,584.86
2018	112,026,095.32
2019	121,215,950.21
2020	123,843,575.74
2021	122,539,322.94

style(metrics.opex("annual", by_category=True))

	operations	port_fees	equipment_cost	total_labor_cost	materials_cost	OpEx
year
2002	0.00	0.00	107,482,514.10	2,317,286.94	3,603,000	113,402,801.04
2003	0.00	0.00	107,778,581.52	2,229,671.87	1,924,000	111,932,253.40
2004	0.00	0.00	118,848,273.29	2,649,658.78	2,838,972	124,336,904.07
2005	0.00	0.00	110,773,711.90	2,246,575.73	3,355,240	116,375,527.63
2006	0.00	0.00	124,293,862.20	2,687,408.32	2,758,140	129,739,410.52
2007	0.00	0.00	105,129,379.12	2,184,186.58	1,923,920	109,237,485.70
2008	0.00	0.00	124,152,154.50	2,653,850.73	2,034,652	128,840,657.23
2009	0.00	0.00	115,739,853.09	2,566,067.45	3,584,152	121,890,072.54
2010	0.00	0.00	112,004,316.91	2,388,654.83	2,219,232	116,612,203.74
2011	0.00	0.00	122,743,796.28	2,624,406.77	2,566,500	127,934,703.05
2012	0.00	0.00	130,097,159.90	2,743,794.67	3,615,900	136,456,854.57
2013	0.00	0.00	116,006,155.90	2,408,348.27	2,962,540	121,377,044.17
2014	0.00	0.00	114,689,940.96	2,482,835.63	3,015,604	120,188,380.58
2015	0.00	0.00	110,851,354.94	2,429,158.81	2,998,872	116,279,385.75
2016	0.00	0.00	112,520,276.31	2,364,231.11	2,516,832	117,401,339.42
2017	0.00	0.00	113,887,335.52	2,558,969.34	2,114,280	118,560,584.86
2018	0.00	0.00	106,900,216.16	2,443,203.16	2,682,676	112,026,095.32
2019	0.00	0.00	116,763,604.62	2,512,213.59	1,940,132	121,215,950.21
2020	0.00	0.00	117,849,594.29	2,613,189.45	3,380,792	123,843,575.74
2021	0.00	0.00	117,790,165.75	2,562,245.19	2,186,912	122,539,322.94

Process Times

Computes the total number of hours spent from repair request submission to completion, performing repairs, and the number of request for each subassembly and repair category. For further documentation, see the API docs here: wombat.core.post_processor.Metrics.process_times().

Inputs:

• include_incompletes

  • True: include requests that have been submitted, but not completed.

  • False: only include requests that have been completed.

Example Usage:

style(metrics.process_times())

		time_to_completion	process_time	downtime	time_to_start	N
subassembly	task
anchor	anchor replacement	18,626.76	9,787.63	9,784.45	9,090.07	18
	major anchor repair	12,539.61	5,570.01	5,569.64	7,121.67	17
array cable	array cable major repair	39,972.39	25,266.76	0.00	16,112.00	39
	array cable replacement	33,798.06	23,202.94	0.00	11,412.63	24
ballast pump	minor ballast pump repair	1,613.38	362.71	345.24	1,272.14	16
drive_train	main shaft major repair	443,494.92	3,179.20	3,174.61	441,543.81	29
	main shaft minor repair	53,403.92	24,484.28	24,161.23	36,294.08	359
	main shaft replacement	27,451.75	8,481.29	8,478.60	19,962.03	17
electrical system	power electrical system major repair	324,892.01	1,400.48	1,396.45	323,814.57	24
	power electrical system major replacement	1,618.64	571.67	571.67	1,327.64	2
	power electrical system minor repair	78,304.01	34,061.93	33,475.82	54,330.66	538
export cable	export cable subsea inspection	10,879.69	2,613.37	0.00	9,238.87	18
generator	annual turbine inspection	1,327,483.29	169,633.65	168,161.77	1,174,034.96	1,426
	direct drive generator major repair	750,814.28	4,448.85	4,437.25	746,888.53	42
	direct drive generator major replacement	42,028.26	17,974.49	17,968.75	24,886.83	20
	direct drive generator minor repair	120,057.64	62,517.72	61,798.34	72,292.88	793
hydraulic pitch system	major pitch system repair	61,050.42	48,649.34	48,469.30	16,913.38	244
	major pitch system replacement	354.83	326.42	326.00	29.08	1
	minor pitch system repair	227,646.65	120,112.54	119,191.03	127,741.53	1,180
mooring lines	buoyancy module replacement	14,817.50	11,553.73	11,494.14	4,065.20	57
	marine growth removal	54,101.04	34,875.35	34,726.48	22,102.35	177
	mooring line major repair	23,739.83	9,572.64	9,569.94	14,348.25	30
	mooring line replacement	10,129.79	5,367.32	5,365.83	5,046.05	11
power converter	power converter major repair	6,598,057.52	28,565.11	28,485.56	6,575,678.96	423
	power converter minor repair	134,380.39	65,802.31	65,023.74	83,349.36	827
	power converter replacement	187,697.57	65,837.42	65,775.65	125,146.48	110
rotor_blades	blades major repair	449,167.28	2,318.02	2,312.76	447,145.84	19
	blades major replacement	6,845.03	4,768.51	4,768.28	2,123.03	2
	blades minor repair	134,957.71	77,626.38	77,086.17	68,931.19	702
supporting_structure	structural annual inspection	1,550,930.67	161,667.07	160,249.52	1,395,600.49	1,440
	structural subsea inspection	1,382,360.34	22,731.66	22,141.60	1,368,067.44	720
transformer	oss annual inspection	10,622.80	7,023.52	6,992.47	5,380.91	38
	oss minor repair	1,368.63	583.24	570.43	1,102.07	6
yaw_system	yaw system major repair	107,432.11	421.27	420.09	107,022.22	11
	yaw system major replacement	3,465.48	1,476.75	1,475.68	2,139.03	4
	yaw system minor repair	34,783.78	17,092.48	16,813.76	22,060.37	264

style(metrics.process_times(include_incompletes=False))

		time_to_completion	process_time	downtime	time_to_start	N
subassembly	task
anchor	anchor replacement	18,626.76	9,787.63	9,784.45	9,090.07	18
	major anchor repair	12,539.61	5,570.01	5,569.64	7,121.67	15
array cable	array cable major repair	39,972.39	25,266.76	0.00	16,112.00	34
	array cable replacement	33,798.06	23,202.94	0.00	11,412.63	23
ballast pump	minor ballast pump repair	1,613.38	362.71	345.24	1,272.14	16
drive_train	main shaft major repair	443,494.92	3,179.20	3,174.61	441,543.81	14
	main shaft minor repair	53,403.92	24,484.28	24,161.23	36,294.08	359
	main shaft replacement	27,451.75	8,481.29	8,478.60	19,962.03	17
electrical system	power electrical system major repair	324,892.01	1,400.48	1,396.45	323,814.57	12
	power electrical system major replacement	1,618.64	571.67	571.67	1,327.64	2
	power electrical system minor repair	78,304.01	34,061.93	33,475.82	54,330.66	537
export cable	export cable subsea inspection	10,879.69	2,613.37	0.00	9,238.87	18
generator	annual turbine inspection	1,327,483.29	169,633.65	168,161.77	1,174,034.96	1,426
	direct drive generator major repair	750,814.28	4,448.85	4,437.25	746,888.53	25
	direct drive generator major replacement	42,028.26	17,974.49	17,968.75	24,886.83	20
	direct drive generator minor repair	120,057.64	62,517.72	61,798.34	72,292.88	793
hydraulic pitch system	major pitch system repair	61,050.42	48,649.34	48,469.30	16,913.38	244
	major pitch system replacement	354.83	326.42	326.00	29.08	1
	minor pitch system repair	227,224.16	120,088.55	119,175.84	127,741.53	1,179
mooring lines	buoyancy module replacement	14,817.50	11,553.73	11,494.14	4,065.20	57
	marine growth removal	54,101.04	34,875.35	34,726.48	22,102.35	177
	mooring line major repair	23,739.83	9,572.64	9,569.94	14,348.25	28
	mooring line replacement	10,129.79	5,367.32	5,365.83	5,046.05	9
power converter	power converter major repair	6,598,057.52	28,565.11	28,485.56	6,575,678.96	222
	power converter minor repair	134,294.45	65,730.31	64,969.36	83,336.40	824
	power converter replacement	187,308.44	65,517.26	65,487.82	125,044.93	109
rotor_blades	blades major repair	449,167.28	2,318.02	2,312.76	447,145.84	14
	blades major replacement	6,845.03	4,768.51	4,768.28	2,123.03	2
	blades minor repair	134,957.71	77,626.38	77,086.17	68,931.19	702
supporting_structure	structural annual inspection	1,550,930.67	161,667.07	160,249.52	1,395,600.49	1,440
	structural subsea inspection	1,379,341.47	22,690.76	22,108.77	1,365,081.16	573
transformer	oss annual inspection	10,622.80	7,023.52	6,992.47	5,380.91	38
	oss minor repair	1,368.63	583.24	570.43	1,102.07	6
yaw_system	yaw system major repair	107,432.11	421.27	420.09	107,022.22	4
	yaw system major replacement	3,465.48	1,476.75	1,475.68	2,139.03	4
	yaw system minor repair	34,783.78	17,092.48	16,813.76	22,060.37	263

Request Summary

Computes the total number of submitted, canceled, incomplete, and completed repair and maintenance request by subassembly and task description. For further documentation, see the API docs here: wombat.core.post_processor.Metrics.request_summary().

Example Usage:

style(metrics.request_summary())

		total_requests	canceled_requests	incomplete_requests	completed_requests
subassembly	task
anchor	anchor replacement	18	0	0	18
	major anchor repair	17	0	2	15
array cable	array cable major repair	39	0	5	34
	array cable replacement	24	0	1	23
ballast pump	minor ballast pump repair	16	0	0	16
drive_train	main shaft major repair	31	2	15	14
	main shaft minor repair	359	0	0	359
	main shaft replacement	17	0	0	17
electrical system	power electrical system major repair	24	0	12	12
	power electrical system major replacement	2	0	0	2
	power electrical system minor repair	538	0	1	537
export cable	export cable subsea inspection	18	0	0	18
generator	annual turbine inspection	1,430	4	0	1,426
	direct drive generator major repair	43	1	17	25
	direct drive generator major replacement	20	0	0	20
	direct drive generator minor repair	793	0	0	793
hydraulic pitch system	major pitch system repair	244	0	0	244
	major pitch system replacement	1	0	0	1
	minor pitch system repair	1,180	0	1	1,179
mooring lines	buoyancy module replacement	57	0	0	57
	marine growth removal	177	0	0	177
	mooring line major repair	30	0	2	28
	mooring line replacement	11	0	2	9
power converter	power converter major repair	536	113	201	222
	power converter minor repair	827	0	3	824
	power converter replacement	113	3	1	109
rotor_blades	blades major repair	19	0	5	14
	blades major replacement	2	0	0	2
	blades minor repair	702	0	0	702
supporting_structure	structural annual inspection	1,440	0	0	1,440
	structural subsea inspection	720	0	147	573
transformer	oss annual inspection	38	0	0	38
	oss minor repair	6	0	0	6
yaw_system	yaw system major repair	11	0	7	4
	yaw system major replacement	4	0	0	4
	yaw system minor repair	264	0	1	263

Power Production

Computes the total power production for the wind farm. For further documentation, see the API docs here: wombat.core.post_processor.Metrics.power_production().

Inputs:

• frequency, as explained above, options: "project", "annual", "monthly", and "month-year"

• by, as explained above options: "windfarm" and "turbine"

• units

  • "kwh": kilowatt-hours (kWh)

  • "mwh": megawatt-hours (MWh)

  • "gwh": gigawatt-hours (GWh)

Example Usage:

# Project totals, in kWh, at the wind farm level
style(metrics.power_production(frequency="project", by="windfarm", units="kwh"))

	windfarm
Project Energy Production (kWh)	106,045,227,443.50

# Project totals, in MWh, at the wind farm level
style(metrics.power_production(frequency="project", units="mwh"))

	windfarm
Project Energy Production (MWh)	106,045,227.44

# Project totals, in GWh, at the wind farm level
style(metrics.power_production(frequency="project"))

	windfarm
Project Energy Production (GWh)	106,045.23

Hydrogen Production

Computes the total hydrogen production for the electrolyzer(s). For further documentation, see the API docs here: wombat.core.post_processor.Metrics.h2_production().

Inputs:

• frequency, as explained above, options: "project", "annual", "monthly", and "month-year"

• by: Similar to the common definition, but with electrolyzer specific inputs.

  • "total": total H2 produced for all electrolyzers

  • "electrolyzer": H2 production for all and each electrolyzer

• units

  • "kgph": kilograms per hour (kgph)

  • "tph": metric tonnes hours (tph)

Example Usage:

Please note, this will raise an error since this analysis does not feature a modeled electrolyzer.

# Project totals, in kWh, at the wind farm level
style(metrics.h2_production(frequency="project", by="total", units="kgph"))

---------------------------------------------------------------------------
ValueError                                Traceback (most recent call last)
Cell In[38], line 2
      1 # Project totals, in kWh, at the wind farm level
----> 2 style(metrics.h2_production(frequency="project", by="total", units="kgph"))

File /opt/hostedtoolcache/Python/3.11.13/x64/lib/python3.11/site-packages/wombat/core/post_processor.py:2327, in Metrics.h2_production(self, frequency, by, units)
   2291 """Calculates the hydrogen production for the simulation at a project, annual,
   2292 or monthly level that can be broken out by electrolyzer.
   2293 
   (...)   2324     If :py:attr:`units` is not one of "kg" or "tn".
   2325 """
   2326 if self.electrolyzer_rated_production.size == 0:
-> 2327     raise ValueError("No electrolyzers available to analyze.")
   2328 frequency = _check_frequency(frequency, which="all")
   2330 by = by.lower().strip()

ValueError: No electrolyzers available to analyze.

Net Present Value

Calculates the net present value (NPV) for the project, as \(NPV = (Power * OfftakePrice - OpEx) / (1 + DiscountRate)\).

For further documentation, see the API docs here: wombat.core.post_processor.Metrics.npv().

Inputs:

• frequency, as explained above, options: "project", "annual", "monthly", and "month-year"

• discount_rate: The rate of return that could be earned on alternative investments, by default 0.025.

• offtake_price: Price of energy, per MWh, by default 80.

style(metrics.opex("annual"))

	OpEx
year
2002	113,402,801.04
2003	111,932,253.40
2004	124,336,904.07
2005	116,375,527.63
2006	129,739,410.52
2007	109,237,485.70
2008	128,840,657.23
2009	121,890,072.54
2010	116,612,203.74
2011	127,934,703.05
2012	136,456,854.57
2013	121,377,044.17
2014	120,188,380.58
2015	116,279,385.75
2016	117,401,339.42
2017	118,560,584.86
2018	112,026,095.32
2019	121,215,950.21
2020	123,843,575.74
2021	122,539,322.94