MhkCosts¶
Wrapper for SAM Simulation Core model: cmod_mhk_costs.cpp
Input Consistency Warning¶
As described in Possible Problems, some input parameters are interdependent but the equations that enforce consistency are not available in this PySAM module. Therefore, the onus is on the PySAM user to check that interdependencies are correctly handled. The variables which may require additional logic include:
Provided for each of these inputs is a list of other inputs that are potentially interdependent.
Creating an Instance¶
Refer to the Initializing a Model page for details on the different ways to create an instance of a PySAM class.
MhkCosts model description
MhkCosts
-
PySAM.MhkCosts.
default
(config) → MhkCosts¶ Use default attributes None
-
PySAM.MhkCosts.
from_existing
(data, optional config) → MhkCosts¶ Share underlying data with an existing PySAM class. If config provided, default attributes are loaded otherwise.
-
PySAM.MhkCosts.
new
() → MhkCosts¶
-
PySAM.MhkCosts.
wrap
(ssc_data_t) → MhkCosts¶ Use existing PySSC data
Warning
Do not call PySSC.data_free on the ssc_data_t provided to
wrap
Functions¶
-
class
PySAM.MhkCosts.
MhkCosts
¶ This class contains all the variable information for running a simulation. Variables are grouped together in the subclasses as properties. If property assignments are the wrong type, an error is thrown.
-
assign
(dict) → None¶ Assign attributes from nested dictionary, except for Outputs
nested_dict = { 'MHKCosts': { var: val, ...}, ...}
-
execute
(int verbosity) → None¶ Execute simulation with verbosity level 0 (default) or 1
-
export
() → dict¶ Export attributes into nested dictionary
-
replace
(dict) → None¶ Replace attributes from nested dictionary, except for Outputs. Unassigns all values in each Group then assigns from the input dict.
nested_dict = { 'MHKCosts': { var: val, ...}, ...}
-
unassign
(name) → None¶ Unassign a value in any of the variable groups.
-
value
(name, optional value) → Union[None, float, dict, sequence, str]¶ Get or set by name a value in any of the variable groups.
-
MHKCosts Group¶
-
class
PySAM.MhkCosts.MhkCosts.
MHKCosts
¶ -
assign
(dict) → None¶ Assign attributes from dictionary, overwriting but not removing values
MHKCosts_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary
-
replace
(dict) → None¶ Replace attributes from dictionary, unassigning values not present in input dict
MHKCosts_vals = { var: val, ...}
-
array_cable_system_cost_input
¶ Array cable system cost [$]
Required: True
Type: float
-
array_cable_system_cost_method
¶ Array cable system cost method [0/1/2]
Options: 0=Enter in $/kW,1=Enter in $,2=Use modeled value
Constraints: MIN=0,MAX=3
Required: True
Type: float
-
assembly_and_install_cost_input
¶ Assembly and installation cost [$]
Required: True
Type: float
-
assembly_and_install_cost_method
¶ Assembly and installation cost method [0/1/2]
Options: 0=Enter in $/kW,1=Enter in $,2=Use modeled value
Constraints: MIN=0,MAX=3
Required: True
Type: float
-
development_cost_input
¶ Development cost [$]
Required: True
Type: float
-
development_cost_method
¶ Development cost method [0/1/2]
Options: 0=Enter in $/kW,1=Enter in $,2=Use modeled value,3=Enter in itemized costs
Constraints: MIN=0,MAX=3
Required: True
Type: float
-
device_rated_power
¶ Rated capacity of device [kW]
Constraints: MIN=0
Required: True
Type: float
-
devices_per_row
¶ Number of wave devices per row in array
Constraints: INTEGER
Required: True
Type: float
-
eng_and_mgmt_cost_input
¶ Engineering and management cost [$]
Required: True
Type: float
-
eng_and_mgmt_cost_method
¶ Engineering and management cost method [0/1/2]
Options: 0=Enter in $/kW,1=Enter in $,2=Use modeled value,3=Enter in itemized costs
Constraints: MIN=0,MAX=3
Required: True
Type: float
-
export_cable_length
¶ Export cable length [m]
Constraints: MIN=0
Required: True
Type: float
-
export_cable_system_cost_input
¶ Export cable system cost [$]
Required: True
Type: float
-
export_cable_system_cost_method
¶ Export cable system cost method [0/1/2]
Options: 0=Enter in $/kW,1=Enter in $,2=Use modeled value
Constraints: MIN=0,MAX=3
Required: True
Type: float
-
inter_array_cable_length
¶ Inter-array cable length [m]
Constraints: MIN=0
Required: True
Type: float
-
lib_wave_device
¶ Wave library name
Required: True if marine_energy_tech=0
Type: str
-
library_or_input_wec
¶ Wave library or user input
Options: 0=Library,1=User
Required: True if marine_energy_tech=0
Type: float
-
marine_energy_tech
¶ Marine energy technology [0/1]
Options: 0=Wave,1=Tidal
Constraints: MIN=0,MAX=1
Required: True
Type: float
-
mooring_found_substruc_cost_input
¶ Mooring, foundation, and substructure cost [$]
Required: True
Type: float
-
mooring_found_substruc_cost_method
¶ Mooring, foundation, and substructure cost method [0/1/2]
Options: 0=Enter in $/kW,1=Enter in $,2=Use modeled value,3=Use itemized costs in $
Constraints: MIN=0,MAX=3
Required: True
Type: float
-
offshore_substation_cost_input
¶ Offshore substation cost [$]
Required: True
Type: float
-
offshore_substation_cost_method
¶ Offshore substation cost method [0/1/2]
Options: 0=Enter in $/kW,1=Enter in $,2=Use modeled value
Constraints: MIN=0,MAX=3
Required: True
Type: float
-
onshore_substation_cost_input
¶ Onshore substation cost [$]
Required: True
Type: float
-
onshore_substation_cost_method
¶ Onshore substation cost method [0/1/2]
Options: 0=Enter in $/kW,1=Enter in $,2=Use modeled value
Constraints: MIN=0,MAX=3
Required: True
Type: float
-
other_elec_infra_cost_input
¶ Other electrical infrastructure cost [$]
Required: True
Type: float
-
other_elec_infra_cost_method
¶ Other electrical infrastructure cost method [0/1/2]
Options: 0=Enter in $/kW,1=Enter in $,2=Use modeled value
Constraints: MIN=0,MAX=3
Required: True
Type: float
-
other_infrastructure_cost_input
¶ Other infrastructure cost [$]
Required: True
Type: float
-
other_infrastructure_cost_method
¶ Other infrastructure cost method [0/1/2]
Options: 0=Enter in $/kW,1=Enter in $,2=Use modeled value
Constraints: MIN=0,MAX=3
Required: True
Type: float
-
power_takeoff_system_cost_input
¶ Power take-off system cost [$]
Required: True
Type: float
-
power_takeoff_system_cost_method
¶ Power take-off system cost method [0/1/2]
Options: 0=Enter in $/kW,1=Enter in $,2=Use modeled value,3=Use itemized costs in $
Constraints: MIN=0,MAX=3
Required: True
Type: float
-
riser_cable_length
¶ Riser cable length [m]
Constraints: MIN=0
Required: True
Type: float
-
structural_assembly_cost_input
¶ Structural assembly cost [$]
Required: True
Type: float
-
structural_assembly_cost_method
¶ Structural assembly cost method [0/1/2]
Options: 0=Enter in $/kW,1=Enter in $,2=Use modeled value,3=Use itemized costs in $
Constraints: MIN=0,MAX=3
Required: True
Type: float
-
system_capacity
¶ System Nameplate Capacity [kW]
Constraints: MIN=0
Required: True
Type: float
-
Outputs Group¶
-
class
PySAM.MhkCosts.MhkCosts.
Outputs
¶ -
assign
(dict) → None¶ Assign attributes from dictionary, overwriting but not removing values
Outputs_vals = { var: val, ...}
-
export
() → dict¶ Export attributes into dictionary
-
replace
(dict) → None¶ Replace attributes from dictionary, unassigning values not present in input dict
Outputs_vals = { var: val, ...}
-
array_cable_system_cost_modeled
¶ Modeled array cable system cost [$]
Type: float
-
assembly_and_install_cost_modeled
¶ Modeled assembly and installation cost [$]
Type: float
-
development_cost_modeled
¶ Modeled development cost [$]
Type: float
-
eng_and_mgmt_cost_modeled
¶ Modeled engineering and management cost [$]
Type: float
-
export_cable_system_cost_modeled
¶ Modeled export cable system cost [$]
Type: float
-
insurance_during_construction
¶ Modeled cost of insurance during construction [$]
Type: float
-
maintenance_cost
¶ Maintenance cost [$]
Type: float
-
mooring_found_substruc_cost_modeled
¶ Modeled mooring, foundation, and substructure cost [$]
Type: float
-
offshore_substation_cost_modeled
¶ Modeled offshore substation cost [$]
Type: float
-
onshore_substation_cost_modeled
¶ Modeled onshore substation cost [$]
Type: float
-
operations_cost
¶ Operations cost [$]
Type: float
-
other_elec_infra_cost_modeled
¶ Modeled other electrical infrastructure cost [$]
Type: float
-
other_infrastructure_cost_modeled
¶ Modeled other infrastructure cost [$]
Type: float
-
plant_commissioning_cost_modeled
¶ Modeled plant commissioning cost [$]
Type: float
-
power_takeoff_system_cost_modeled
¶ Modeled power take-off cost [$]
Type: float
-
project_contingency
¶ Modeled project contingency cost [$]
Type: float
-
reserve_accounts
¶ Modeled reserve account costs [$]
Type: float
-
site_access_port_staging_cost_modeled
¶ Modeled site access, port, and staging cost [$]
Type: float
-
structural_assembly_cost_modeled
¶ Modeled structural assembly cost [$]
Type: float
-