MhkCosts

MhkCosts

PySAM.MhkCosts.default(config) → MhkCosts

Load defaults for the configuration config. Available configurations are:

• None

Note

Some inputs do not have default values and may be assigned a value from the variable’s Required attribute. See variable attribute descriptions below.

PySAM.MhkCosts.from_existing(data, optional config) → MhkCosts

Share data with an existing PySAM class. If optional config is a valid configuration name, load the module’s defaults for that configuration.

PySAM.MhkCosts.new() → MhkCosts

PySAM.MhkCosts.wrap(ssc_data_t) → MhkCosts

Load data from a PySSC object.

Warning

Do not call PySSC.data_free on the ssc_data_t provided to wrap()

MhkCosts is a wrapper for the SSC compute module cmod_mhk_costs.cpp

Interdependent Variables

The variables listed below are interdependent with other variables. If you change the value of one of these variables, you may need to change values of other variables. The SAM user interface manages these interdependent variables, but in PySAM, it is up to you change the value of all interdependent variables so they are consistent. See Interdependent Variables for examples and details.

• None

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

get_data_ptr() → Pointer

Get ssc_data_t pointer

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) → 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, ...}

assembly_and_install_cost_input

Assembly and installation cost [$]

Required: assembly_and_install_cost_method<2

Type:

float

assembly_and_install_cost_method

Assembly and installation cost method [0-4]

Options: 0=Enter in $/kW,1=Enter in $,2=Use modeled value

Constraints: MIN=0,MAX=4

Required: True

Type:

float

assembly_and_install_cost_rvalue

Assembly and installation R-value

Constraints: MIN=0,MAX=1

Required: Required if assembly_and_install_cost_method=4

Type:

float

assembly_and_install_cost_total

Assembly and installation itemized cost total [$]

Required: Required if assembly_and_install_cost_method=3

Type:

float

development_cost_input

Development cost [$]

Required: development_cost_method<2

Type:

float

development_cost_method

Development cost method [0-4]

Options: 0=Enter in $/kW,1=Enter in $,2=Use modeled value,3=Enter in itemized costs

Constraints: MIN=0,MAX=4

Required: True

Type:

float

development_cost_rvalue

Development R-value

Constraints: MIN=0,MAX=1

Required: Required if development_cost_method=4

Type:

float

development_cost_total

Development itemized cost total [$]

Required: Required if development_cost_method=3

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

elec_infras_cost_input

Electrical infrastructure cost [$]

Required: elec_infras_cost_method<2

Type:

float

elec_infras_cost_method

Electrical infrastructure cost method [0-4]

Options: 0=Enter in $/kW,1=Enter in $,2=Use modeled value

Constraints: MIN=0,MAX=4

Required: True

Type:

float

elec_infras_cost_modeled

Electrical infrastructure cost modeled [$]

Required: Required if elec_infras_cost_method=2

Type:

float

elec_infras_cost_rvalue

Electrical infrastructure R-value

Constraints: MIN=0,MAX=1

Required: Required if elec_infras_cost_method=4

Type:

float

elec_infras_cost_total

Electrical infrastructure itemized cost total [$]

Required: Required if elec_infras_cost_method=3

Type:

float

eng_and_mgmt_cost_input

Engineering and management cost [$]

Required: eng_and_mgmt_cost_method<2

Type:

float

eng_and_mgmt_cost_method

Engineering and management cost method [0-4]

Options: 0=Enter in $/kW,1=Enter in $,2=Use modeled value,3=Enter in itemized costs

Constraints: MIN=0,MAX=4

Required: True

Type:

float

eng_and_mgmt_cost_rvalue

Engineering and management R-value

Constraints: MIN=0,MAX=1

Required: Required if eng_and_mgmt_cost_method=4

Type:

float

eng_and_mgmt_cost_total

Engineering and management itemized cost total [$]

Required: Required if eng_and_mgmt_cost_method=3

Type:

float

insurance_during_construction_cost_input

Insurance during construction cost [$]

Required: insurance_during_construction_cost_method<2

Type:

float

insurance_during_construction_cost_method

Insurance during construction cost method [0-3]

Options: 0=Enter in $/kW,1=Enter in $,2=Use modeled value

Constraints: MIN=0,MAX=4

Required: True

Type:

float

insurance_during_construction_cost_rvalue

Insurance during construction R-value

Constraints: MIN=0,MAX=1

Required: Required if insurance_during_construction_cost_method=3

Type:

float

lib_tidal_device

Tidal library name

Required: Required if marine_energy_tech=1

Type:

str

lib_wave_device

Wave library name

Required: Required if marine_energy_tech=0

Type:

str

library_or_input_wec

Wave library or user input

Options: 0=Library,1=User

Required: Required if marine_energy_tech=0

Type:

float

maintenance_cost_input

Maintenance cost [$]

Required: maintenance_cost_method<2

Type:

float

maintenance_cost_method

Maintenance cost method [0-4]

Options: 0=Enter in $/kW,1=Enter in $,2=Use modeled value

Constraints: MIN=0,MAX=4

Required: True

Type:

float

maintenance_cost_rvalue

Maintenance R-value

Constraints: MIN=0,MAX=1

Required: Required if maintenance_cost_method=4

Type:

float

maintenance_cost_total

Maintenance itemized cost total [$]

Required: Required if maintenance_cost_method=3

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: mooring_found_substruc_cost_method<2

Type:

float

mooring_found_substruc_cost_method

Mooring, foundation, and substructure cost method [0-4]

Options: 0=Enter in $/kW,1=Enter in $,2=Use modeled value,3=Use itemized costs in $

Constraints: MIN=0,MAX=4

Required: True

Type:

float

mooring_found_substruc_cost_rvalue

Mooring, foundation, and substructure R-value

Constraints: MIN=0,MAX=1

Required: Required if mooring_found_substruc_cost_method=4

Type:

float

mooring_found_substruc_cost_total

Mooring, foundation, and substructure itemized cost total [$]

Required: Required if mooring_found_substruc_cost_method=3

Type:

float

operations_cost_input

Operations cost [$]

Required: operations_cost_method<2

Type:

float

operations_cost_method

Operations cost method [0-4]

Options: 0=Enter in $/kW,1=Enter in $,2=Use modeled value

Constraints: MIN=0,MAX=4

Required: True

Type:

float

operations_cost_rvalue

Operations R-value

Constraints: MIN=0,MAX=1

Required: Required if operations_cost_method=4

Type:

float

operations_cost_total

Operations itemized cost total [$]

Required: Required if operations_cost_method=3

Type:

float

other_financial_cost_input

Other financial cost [$,$/kW]

Required: other_financial_cost_method<2

Type:

float

other_financial_cost_method

Other financial cost method [0-3]

Options: 0=Enter in $/kW,1=Enter in $,2=Use modeled value

Constraints: MIN=0,MAX=4

Required: True

Type:

float

other_financial_cost_rvalue

Other financial R-value

Constraints: MIN=0,MAX=1

Required: Required if other_financial_cost_method=3

Type:

float

other_infrastructure_cost_input

Other infrastructure cost [$]

Required: other_infrastructure_cost_method<2

Type:

float

other_infrastructure_cost_method

Other infrastructure cost method [0-4]

Options: 0=Enter in $/kW,1=Enter in $,2=Use modeled value

Constraints: MIN=0,MAX=4

Required: True

Type:

float

other_infrastructure_cost_rvalue

Other infrastructure R-value

Constraints: MIN=0,MAX=1

Required: Required if other_infrastructure_cost_method=4

Type:

float

other_infrastructure_cost_total

Other infrastructure itemized cost total [$]

Required: Required if other_infrastructure_cost_method=3

Type:

float

plant_commissioning_cost_input

Plant commissioning cost [$]

Required: plant_commissioning_cost_method<2

Type:

float

plant_commissioning_cost_method

Plant commissioning cost method [0-3]

Options: 0=Enter in $/kW,1=Enter in $,2=Use modeled value

Constraints: MIN=0,MAX=4

Required: True

Type:

float

plant_commissioning_cost_rvalue

Plant commissioning R-value

Constraints: MIN=0,MAX=1

Required: Required if plant_commissioning_cost_method=4

Type:

float

power_takeoff_system_cost_input

Power take-off system cost [$]

Required: power_takeoff_system_cost_method<2

Type:

float

power_takeoff_system_cost_method

Power take-off system cost method [0-4]

Options: 0=Enter in $/kW,1=Enter in $,2=Use modeled value,3=Use itemized costs in $

Constraints: MIN=0,MAX=4

Required: True

Type:

float

power_takeoff_system_cost_total

Power take-off system cost itemized cost total [$]

Required: Required if power_takeoff_system_cost_method=3

Type:

float

project_contingency_cost_input

Project contingency cost [$]

Required: project_contingency_cost_method<2

Type:

float

project_contingency_cost_method

Project contingency cost method [0-3]

Options: 0=Enter in $/kW,1=Enter in $,2=Use modeled value

Constraints: MIN=0,MAX=4

Required: True

Type:

float

project_contingency_cost_rvalue

Project contingency R-value

Constraints: MIN=0,MAX=1

Required: Required if project_contingency_cost_method=3

Type:

float

reserve_accounts_cost_input

Reserve accounts cost [$]

Required: reserve_accounts_cost_method<2

Type:

float

reserve_accounts_cost_method

Reserve accounts cost method [0-4]

Options: 0=Enter in $/kW,1=Enter in $,2=Use modeled value

Constraints: MIN=0,MAX=4

Required: True

Type:

float

reserve_accounts_cost_rvalue

Reserve accounts R-value

Constraints: MIN=0,MAX=1

Required: Required if reserve_accounts_cost_method=4

Type:

float

reserve_accounts_cost_total

Reserve accounts itemized cost total [$]

Required: Required if reserve_accounts_cost_method=3

Type:

float

site_access_port_staging_cost_input

Site access and port staging cost [$]

Required: site_access_port_staging_cost_method<2

Type:

float

site_access_port_staging_cost_method

Site access and port staging cost method [0-4]

Options: 0=Enter in $/kW,1=Enter in $,2=Use modeled value

Constraints: MIN=0,MAX=4

Required: True

Type:

float

site_access_port_staging_cost_rvalue

Site access and port staging R-value

Constraints: MIN=0,MAX=1

Required: Required if site_access_port_staging_cost_method=4

Type:

float

site_access_port_staging_cost_total

Site access and port staging itemized cost total [$]

Required: Required if site_access_port_staging_cost_method=3

Type:

float

structural_assembly_cost_input

Structural assembly cost [$]

Required: structural_assembly_cost_method<2

Type:

float

structural_assembly_cost_method

Structural assembly cost method [0-4]

Options: 0=Enter in $/kW,1=Enter in $,2=Use modeled value,3=Use itemized costs in $

Constraints: MIN=0,MAX=4

Required: True

Type:

float

structural_assembly_cost_rvalue

Structural assembly R-value

Constraints: MIN=0,MAX=1

Required: Required if structural_assembly_cost_method=4

Type:

float

structural_assembly_cost_total

Structural assembly itemized cost total [$]

Required: Required if structural_assembly_cost_method=3

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, ...}

assembly_and_install_cost

Assembly and installation cost [$]

Type:

float

assembly_and_install_cost_modeled

Modeled assembly and installation cost [$]

Type:

float

development_cost

Development cost [$]

Type:

float

development_cost_modeled

Modeled development cost [$]

Type:

float

eng_and_mgmt_cost

Engineering and management cost [$]

Type:

float

eng_and_mgmt_cost_modeled

Modeled engineering and management cost [$]

Type:

float

insurance_during_construction_cost

Cost of insurance during construction [$]

Type:

float

insurance_during_construction_cost_modeled

Modeled cost of insurance during construction [$]

Type:

float

maintenance_cost

Maintenance cost [$]

Type:

float

maintenance_cost_modeled

Modeled maintenance cost [$]

Type:

float

mooring_found_substruc_cost

Mooring, foundation, and substructure cost [$]

Type:

float

mooring_found_substruc_cost_modeled

Modeled mooring, foundation, and substructure cost [$]

Type:

float

operations_cost

Operations cost [$]

Type:

float

operations_cost_modeled

Modeled operations cost [$]

Type:

float

other_financial_cost

Cost of other financial considerations [$]

Type:

float

other_financial_cost_modeled

Modeled cost of other financial considerations [$]

Type:

float

other_infrastructure_cost

Other infrastructure cost [$]

Type:

float

other_infrastructure_cost_modeled

Modeled other infrastructure cost [$]

Type:

float

plant_commissioning_cost

Plant commissioning cost [$]

Type:

float

plant_commissioning_cost_modeled

Modeled plant commissioning cost [$]

Type:

float

power_takeoff_system_cost

Power take-off cost [$]

Type:

float

power_takeoff_system_cost_modeled

Modeled power take-off cost [$]

Type:

float

project_contingency_cost

Project contingency cost [$]

Type:

float

project_contingency_cost_modeled

Modeled project contingency cost [$]

Type:

float

reserve_accounts_cost

Reserve account costs [$]

Type:

float

reserve_accounts_cost_modeled

Modeled reserve account costs [$]

Type:

float

site_access_port_staging_cost

Site access, port, and staging cost [$]

Type:

float

site_access_port_staging_cost_modeled

Modeled site access, port, and staging cost [$]

Type:

float

structural_assembly_cost

Structural assembly cost [$]

Type:

float

structural_assembly_cost_modeled

Modeled structural assembly cost [$]

Type:

float