PySAM

https://nrel-pysam.readthedocs.io/en/main
Admin
PySAM is a Python package for the System Advisor Model (SAM) that provides tools for interacting...
Tokens:140,249
Snippets:1,959
Trust Score:8.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Configure setup.py Arguments

Source: https://nrel-pysam.readthedocs.io/en/main/pyssc-for-dao-tk.html

Example configuration for the setup function in setup.py files.

```python
name='NREL-PySAM-DAO-Tk' [append '-stubs' for /stubs/setup.py]
...
url='https://github.com/natlabrockies/dao-tk'
description="National Renewable Energy Laboratory's DAO-Tk Python Wrapper" [append ', stub files' for /stubs/setup.py]
...
author="Matthew-Boyd"
author_email="matthew.boyd@nrel.gov"
...
packages=['PySAM-DAO-Tk'], [append '-stubs' for /stubs/setup.py]
package_dir={'PySAM-DAO-Tk': 'files'}, [change to: {'PySAM-DAO-Tk-stubs': 'stubs/stubs'} for stubs file]
...
install_requires=['NREL-PySAM-DAO-Tk-stubs'],
```

--------------------------------

### Initialize PySAM Module Instance

Source: https://nrel-pysam.readthedocs.io/en/main/_sources/variables-pysam.rst.txt

Setup required for subsequent variable manipulation examples using the Pvwattsv8 module.

```python
import PySAM.Pvwattsv8 as pv

system_model = pv.default('PVWattsNone')
```

--------------------------------

### Install DAO-Tk Environment

Source: https://nrel-pysam.readthedocs.io/en/main/pyssc-for-dao-tk.html

Commands to create and activate a Conda environment and install the DAO-Tk package.

```bash
conda create --name pysam_daotk python=3.7 -y
```

```bash
conda activate pysam_daotk
```

```bash
pip install nrel-pysam-dao-tk
```

--------------------------------

### Install DAO-Tk PySAM

Source: https://nrel-pysam.readthedocs.io/en/main/_sources/pyssc-for-dao-tk.rst.txt

Install the nrel-pysam-dao-tk package via pip.

```bash
pip install nrel-pysam-dao-tk
```

--------------------------------

### Upload Wheels to PyPI

Source: https://nrel-pysam.readthedocs.io/en/main/_sources/pyssc-for-dao-tk.rst.txt

Installs twine and uploads the generated wheel files to PyPI.

```bash
pip install twine
twine upload %PYSAMDIR%\dist\*.whl
```

--------------------------------

### Run simulation with defaults and custom weather file

Source: https://nrel-pysam.readthedocs.io/en/main/_sources/defaults.rst.txt

Completes the configuration setup by assigning a valid weather file path and executing the simulation for each module.

```python
import PySAM.Pvsamv1 as pv
import PySAM.Grid as gr
import PySAM.Utilityrate5 as ur
import PySAM.Cashloan as co

print('Loading defaults...')
system_model = pv.default('FlatPlatePVCommercial')
grid_model = gr.from_existing(system_model,'FlatPlatePVCommercial')
utilityrate_model = ur.from_existing(system_model,'FlatPlatePVCommercial')
financial_model = co.from_existing(system_model,'FlatPlatePVCommercial')

# path to small collection of default weather files that come with SAM
# edit and set as needed for Windows, Mac, Linux
wf_paths = ['C:\\SAM\\2021.12.02r1\\solar_resource\\',
 '/home/Applications/SAM_2021.12.02r1/SAM.app/Contents/solar_resource/',
'/home/sam/2021.12.02.r1/solar_resource/']
wf_name = 'phoenix_az_33.450495_-111.983688_psmv3_60_tmy.csv' # default for PV - Commercial configurations

# for wf_paths 0 = windows, 1=mac, 2=linux as defined above
filename = wf_paths[0] + wf_name
system_model.SolarResource.solar_resource_file = filename

print('Simulating...')
system_model.execute()
grid_model.execute()
utilityrate_model.execute()
financial_model.execute()

print('Done.')
print(system_model.value('annual_energy'))
print(financial_model.Outputs.npv)
```

--------------------------------

### Select VS Code interpreter

Source: https://nrel-pysam.readthedocs.io/en/main/_sources/pyssc-for-dao-tk.rst.txt

Example of the interpreter string to select in VS Code.

```bash
Python 3.7.8 64-bit ('pysam_daotk': conda)
```

--------------------------------

### Initialize compute modules with defaults

Source: https://nrel-pysam.readthedocs.io/en/main/_sources/defaults.rst.txt

Demonstrates loading defaults for a Detailed PV-Battery configuration using default() for the first module and from_existing() for subsequent modules.

```python
import PySAM.Pvsamv1 as pv
import PySAM.Grid as gr
import PySAM.Utilityrate5 as ur
import PySAM.Cashloan as co

system_model = pv.default('PVBatteryCommercial')

grid_model = gr.from_existing(system_model, 'PVBatteryCommercial')
utilityrate_model = ur.from_existing(system_model, 'PVBatteryCommercial')
financial_model = so.from_existing(system_model, 'PVBatteryCommercial')
```

--------------------------------

### Configure and run a hybrid system simulation

Source: https://nrel-pysam.readthedocs.io/en/main/hybrids.html

Demonstrates initializing a PVWatts, Wind, and Battery hybrid system and using three different methods to update input parameters and execute the simulation.

```python
# import the module for each performance model
import PySAM.Battery as battery_model
import PySAM.Windpower as wind_model
import PySAM.Pvwattsv8 as pv_model

# import the hybrid system class
from PySAM.Hybrids.HybridSystem import HybridSystem

# Create the hybrid system model
m = HybridSystem([pv_model, wind_model, battery_model], 'singleowner')

# load input values from defaults for the
# PVWatts Wind Battery / Single Owner configuration
# default configuration is for a 100 MW PV system with 80 2.5 MW turbines
m.default('PVWattsWindBatteryHybridSingleOwner')

# assign values to solar and wind resource files (these are not loaded with defaults)
solar_resource_path = '/path-to-weather-file/your-solar-weather-file-goes-here.csv'
wind_resource_path =  '/path-to-weather-file/your-wind-weather-file-goes-here.csv'

m.pvwatts.SolarResource.solar_resource_file = str(solar_resource_path)
m.wind.Resource.wind_resource_filename = str(wind_resource_path)

# Method 1: set variable values directly for a 8 MW PV system with four 2.5 MW turbines
# Note the module names "pvwatts" and "wind" as defined by the HybridSystem class,
# instead of PySAM module names "Pvwattsv8" and "Windpower".
m.pvwatts.SystemDesign.system_capacity = 8000
m.wind.Farm.wind_farm_xCoordinates = [0, 800, 1600, 2400]
m.wind.Farm.wind_farm_yCoordinates = [0, 0, 0, 0]
m.wind.Farm.system_capacity = 10000

# run a simulation
m.execute()

# print some outputs
print(m.pvwatts.Outputs.ac_annual)
print(m.wind.Outputs.annual_energy)

# Method 2: Use `value()` for a 4 MW PV system with two 2.5 MW turbines
m.pvwatts.value("system_capacity", 4000)
m.wind.value("wind_farm_xCoordinates", [0, 800])
m.wind.value("wind_farm_yCoordinates", [0, 0])
m.wind.value("system_capacity", 5000)

m.execute()

print(m.pvwatts.value("ac_annual"))
print(m.wind.value("annual_energy"))

# Method 3: Use `assign()` for a 6 MW PV system with three 2.5 MW turbines
inputs_dict = {
        "pvwatts": {"SystemDesign": {"system_capacity": 6000} },
        "wind": {"Farm": {"wind_farm_xCoordinates": [0, 800, 1600]} },
        "wind": {"Farm": {"wind_farm_yCoordinates": [0, 0, 0]} },
        "wind": {"Farm": {"system_capacity": 7500} }
}
m.assign(inputs_dict)

m.execute()

print(m.pvwatts.value("ac_annual"))
print(m.wind.value("annual_energy"))
```

--------------------------------

### Initialization Methods

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Solarpilot.html

Methods for creating or wrapping a Solarpilot simulation instance.

```APIDOC
## PySAM.Solarpilot.default(config)
### Description
Load defaults for the specified configuration.

## PySAM.Solarpilot.from_existing(data, optional_config)
### Description
Share data with an existing PySAM class instance.

## PySAM.Solarpilot.new()
### Description
Create a new instance of the Solarpilot class.

## PySAM.Solarpilot.wrap(ssc_data_t)
### Description
Load data from an existing PySSC object.
```

--------------------------------

### Install PySAM via pip

Source: https://nrel-pysam.readthedocs.io/en/main/_sources/installation.rst.txt

Use this command to install the nrel-pysam package from the Python Package Index.

```bash
pip install nrel-pysam
```

--------------------------------

### Run manylinux container

Source: https://nrel-pysam.readthedocs.io/en/main/_sources/pyssc-for-dao-tk.rst.txt

Start the Docker container with the current directory mounted to /io.

```bash
docker run --rm -dit -v %cd%:/io quay.io/pypa/manylinux1_x86_64 /sbin/init
```

--------------------------------

### PySAM.TcsmoltenSalt.value

Source: https://nrel-pysam.readthedocs.io/en/main/modules/TcsmoltenSalt.html

Gets or sets a variable value.

```APIDOC
## value(name, value=None)

### Description
Gets or sets a value for a specific variable within the simulation groups.

### Parameters
- **name** (string) - Required - The name of the variable.
- **value** (float|dict|sequence|str) - Optional - The value to assign to the variable.
```

--------------------------------

### Thirdpartyownership.value

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Thirdpartyownership.html

Gets or sets a value by name.

```APIDOC
## value(name, value)

### Description
Get or set a value in any of the variable groups by name.

### Parameters
- **name** (str) - Required - The name of the variable.
- **value** (optional) - Optional - The value to set for the variable.
```

--------------------------------

### Create a Photovoltaic Wind Battery Hybrid Model from Defaults

Source: https://nrel-pysam.readthedocs.io/en/main/_sources/hybrids.rst.txt

Initializes a hybrid system using predefined default configurations and manually assigned resource files.

```python
# get performance model for each subsystem
	import PySAM.Pvsamv1 as pv_model
	import PySAM.Windpower as wind_model
	import PySAM.Battery as battery_model
	
	# get function for managing hybrid variables and simulations
	from PySAM.Hybrids.HybridSystem import HybridSystem
	
	# create the hybrid system model using performance model names as defined by the import statements above
	# use the string 'hostdeveloper' or 'singleowner' for the financial model
	m = HybridSystem([pv_model, wind_model, battery_model], 'singleowner')
	
	# load defaults for the Photovoltaid Wind Battery Hybrid / Single Owner configuration
	m.default('PhotovoltaicWindBatteryHybridSingleOwner')
	
	# assign values to solar and wind resource files (these are not loaded with defaults)
	solar_resource_path = '/path-to-weather-file/your-solar-weather-file-goes-here.csv'
	wind_resource_path =  '/path-to-weather-file/your-wind-weather-file-goes-here.csv'
	
	m.pv.SolarResource.solar_resource_file = solar_resource_path
	m.wind.Resource.wind_resource_filename = wind_resource_path
	
	# run a simulation
	print('running...')
	m.execute()
	
	# store some outputs
	# be careful to use the correct module names as defined by the HybridSystem() function: 
	#     pv, pvwatts, wind, custom, battery, fuelcell
	#     _grid, singleowner, utilityrate5, host_developer
	pvannualenergy = m.pv.Outputs.annual_energy
	windannualenergy = m.wind.Outputs.annual_energy
	battrountripefficiency = m.battery.Outputs.average_battery_roundtrip_efficiency
	gridannualenergy = m._grid.SystemOutput.annual_energy
	npv = m.singleowner.Outputs.project_return_aftertax_npv
	
	# print outputs
	print(pvannualenergy)
	print(windannualenergy)
	print(battrountripefficiency)
	print(gridannualenergy)
	print(npv)
```

--------------------------------

### Pvwattsv7 Initialization Methods

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Pvwattsv7.html

Methods used to instantiate or wrap a Pvwattsv7 compute module instance.

```APIDOC
## Pvwattsv7 Initialization

### Methods
- `default()`: Returns an instance of the module with default values.
- `from_existing(existing)`: Creates an instance from an existing PySSC object.
- `new()`: Creates a new instance of the module.
- `wrap(ssc_handle)`: Wraps an existing SSC handle into the Pvwattsv7 module interface.
```

--------------------------------

### PySAM.LcoefcrDesign.value

Source: https://nrel-pysam.readthedocs.io/en/main/modules/LcoefcrDesign.html

Gets or sets a value by name.

```APIDOC
## LcoefcrDesign.value(name, optional value)

### Description
Gets or sets a value in any of the variable groups by its name.

### Parameters
- **name** (string) - Required - The name of the variable.
- **optional value** (float|dict|sequence|str) - Optional - The value to set if provided.
```

--------------------------------

### Access and Set Hybrid System Variables

Source: https://nrel-pysam.readthedocs.io/en/main/_sources/hybrids.rst.txt

Demonstrates initializing a hybrid system, setting inputs via direct attribute access, value() method, and assign() method, and executing simulations.

```python
# import the module for each performance model
import PySAM.Battery as battery_model
import PySAM.Windpower as wind_model
import PySAM.Pvwattsv8 as pv_model

# import the hybrid system class
from PySAM.Hybrids.HybridSystem import HybridSystem

# Create the hybrid system model
m = HybridSystem([pv_model, wind_model, battery_model], 'singleowner')

# load input values from defaults for the 
# PVWatts Wind Battery / Single Owner configuration
# default configuration is for a 100 MW PV system with 80 2.5 MW turbines
m.default('PVWattsWindBatteryHybridSingleOwner')

# assign values to solar and wind resource files (these are not loaded with defaults)
solar_resource_path = '/path-to-weather-file/your-solar-weather-file-goes-here.csv'
wind_resource_path =  '/path-to-weather-file/your-wind-weather-file-goes-here.csv'

m.pvwatts.SolarResource.solar_resource_file = str(solar_resource_path)
m.wind.Resource.wind_resource_filename = str(wind_resource_path)

# Method 1: set variable values directly for a 8 MW PV system with four 2.5 MW turbines
# Note the module names "pvwatts" and "wind" as defined by the HybridSystem class,
# instead of PySAM module names "Pvwattsv8" and "Windpower".
m.pvwatts.SystemDesign.system_capacity = 8000
m.wind.Farm.wind_farm_xCoordinates = [0, 800, 1600, 2400]
m.wind.Farm.wind_farm_yCoordinates = [0, 0, 0, 0]
m.wind.Farm.system_capacity = 10000

# run a simulation
m.execute()

# print some outputs
print(m.pvwatts.Outputs.ac_annual)
print(m.wind.Outputs.annual_energy)

# Method 2: Use `value()` for a 4 MW PV system with two 2.5 MW turbines
m.pvwatts.value("system_capacity", 4000)
m.wind.value("wind_farm_xCoordinates", [0, 800])
m.wind.value("wind_farm_yCoordinates", [0, 0])
m.wind.value("system_capacity", 5000)

m.execute()

print(m.pvwatts.value("ac_annual"))
print(m.wind.value("annual_energy"))

# Method 3: Use `assign()` for a 6 MW PV system with three 2.5 MW turbines
inputs_dict = {
	"pvwatts": {"SystemDesign": {"system_capacity": 6000} },
	"wind": {"Farm": {"wind_farm_xCoordinates": [0, 800, 1600]} },
	"wind": {"Farm": {"wind_farm_yCoordinates": [0, 0, 0]} }, 
	"wind": {"Farm": {"system_capacity": 7500} }
}
m.assign(inputs_dict)

m.execute()

print(m.pvwatts.value("ac_annual"))
print(m.wind.value("annual_energy"))
```

--------------------------------

### PySAM.TestUdPowerCycle.value

Source: https://nrel-pysam.readthedocs.io/en/main/modules/TestUdPowerCycle.html

Get or set a variable value by name.

```APIDOC
## PySAM.TestUdPowerCycle.value(name, optional value)

### Description
Get or set a value in any of the variable groups by name.

### Parameters
- **name** (str) - The name of the variable.
- **value** (float|dict|sequence|str) - Optional value to set.

### Returns
- **None | float | dict | sequence | str** - The value if getting, or None if setting.
```

--------------------------------

### Build PVWatts Single Owner Model from Defaults

Source: https://nrel-pysam.readthedocs.io/en/main/_sources/getting-started.rst.txt

Initializes a full configuration using default values and shared data, requiring a valid weather file path for execution.

```python
import os # need this to get user path for weather file

# import compute modules required for the PVWatts - Single Owner configuration
import PySAM.Pvwattsv8 as pv
import PySAM.Grid as gr
import PySAM.Utilityrate5 as ur
import PySAM.Singleowner as so

# create an instance of the Pvwattsv8 module with defaults from the PVWatts - Single Owner configuration
system_model = pv.default('PVWattsSingleOwner')

# create instances of the other modules with shared data from the PVwattsv8 module
grid_model = gr.from_existing(system_model, 'PVWattsSingleOwner')
utilityrate_model = ur.from_existing(system_model, 'PVWattsSingleOwner')
financial_model = so.from_existing(system_model, 'PVWattsSingleOwner')

# use weather file downloaded from SAM as "denver, co", you can replace this with a path to any valid weather file in the SAM CSV format
filename = os.path.expanduser('~') + '/SAM Downloaded Weather Files/denver_co_39.7385_-104.985_psm3-tmy_60_tmy.csv'
system_model.SolarResource.solar_resource_file = filename

# run the modules in the correct order
system_model.execute()
grid_model.execute()
utilityrate_model.execute()
financial_model.execute()

# display results
print( 'Annual AC Output in Year 1 = {:,.3f} kWh'.format( system_model.Outputs.ac_annual ) )
print( 'Net Present Value = ${:,.2f}'.format(financial_model.Outputs.project_return_aftertax_npv) )
```

--------------------------------

### PySAM.Communitysolar.value

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Communitysolar.html

Gets or sets a variable value by name.

```APIDOC
## Communitysolar.value(name, value)

### Description
Get or set by name a value in any of the variable groups.

### Parameters
- **name** (str) - Required - The name of the variable.
- **value** (float | dict | sequence | str) - Optional - The value to assign to the variable.
```

--------------------------------

### Assign SystemOutput values

Source: https://nrel-pysam.readthedocs.io/en/main/modules/CashloanHeat.html

Example dictionary structure for assigning values to the SystemOutput group.

```python
SystemOutput_vals = { var: val, ...}
```

--------------------------------

### Layoutarea Initialization Methods

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Layoutarea.html

Methods available for initializing the Layoutarea module instance.

```APIDOC
## Layoutarea Initialization

### Methods
- `default()`: Creates a new instance of the Layoutarea module with default values.
- `from_existing(existing_instance)`: Creates a new instance of the Layoutarea module from an existing instance.
- `new()`: Creates a new instance of the Layoutarea module.
- `wrap(ssc_data_ptr)`: Wraps an existing SSC data pointer into a Layoutarea module instance.
```

--------------------------------

### FresnelPhysical.value

Source: https://nrel-pysam.readthedocs.io/en/main/modules/FresnelPhysical.html

Gets or sets a specific variable value.

```APIDOC
## value(name, value)

### Description
Get or set a value in any of the variable groups by its name.

### Parameters
- **name** (str) - Required - The name of the variable.
- **value** (optional) - Optional - The value to set for the variable.
```

--------------------------------

### PySAM.Pvwattsv7.value

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Pvwattsv7.html

Gets or sets a value for a specific variable in the simulation.

```APIDOC
## value(name, optional value)

### Description
Get or set by name a value in any of the variable groups.

### Parameters
- **name** (string) - Required - The name of the variable.
- **optional value** (float|dict|sequence|str) - Optional - The value to assign to the variable.
```

--------------------------------

### Utilityrate5 Initialization Methods

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Utilityrate5.html

Methods used to initialize the Utilityrate5 module instance.

```APIDOC
## Utilityrate5 Initialization

### Methods
- `default()`: Creates an instance with default values.
- `from_existing(existing)`: Creates an instance from an existing object.
- `new()`: Creates a new instance.
- `wrap(ssc_data)`: Wraps existing SSC data into the module.
```

--------------------------------

### Run a PVWatts model using JSON inputs

Source: https://nrel-pysam.readthedocs.io/en/main/getting-started.html

Demonstrates loading model parameters from a JSON file, executing the simulation, and modifying inputs programmatically.

```python
import json
import PySAM.Pvwattsv8 as pv # import the PVWatts module from PySAM

# create a new instance of the Pvwattsv8 module
pv_model = pv.new()

# get the inputs from the JSON file
with open( 'untitled_pvwattsv8.json', 'r') as f:
        pv_inputs = json.load( f )

# iterate through the input key-value pairs and set the module inputs
for k, v in pv_inputs.items():
    if k != 'number_inputs':
        pv_model.value(k, v)

# run the module
pv_model.execute()

# print results
print('Annual AC output for {capacity:,.2f} kW system is {output:,.0f} kWh.\n'.format(capacity = pv_model.value('system_capacity'), output = pv_model.Outputs.ac_annual) )

# run PVWatts for a series of nameplate capacities
capacities = [10, 100, 1000]
for c in capacities:
    # change the value of the system_capacity input
    pv_model.value('system_capacity',c)
    # run the module
    pv_model.execute()
    # print some results
    print('Annual AC output for {capacity:,.2f} kW system is {output:,.0f} kWh.'.format(capacity = pv_model.value('system_capacity'), output = pv_model.Outputs.ac_annual) )
```

--------------------------------

### PySAM.Pvwattsv5.value

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Pvwattsv5.html

Get or set a value for a specific variable in the simulation.

```APIDOC
## value(name, optional value)

### Description
Get or set by name a value in any of the variable groups.

### Parameters
- **name** (string) - Required - The name of the variable.
- **optional value** (float|dict|sequence|str) - Optional - The value to set for the variable.
```

--------------------------------

### PySAM.Pvsandiainv.value

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Pvsandiainv.html

Gets or sets a value for a specific variable in the simulation.

```APIDOC
## PySAM.Pvsandiainv.value(name, optional value)

### Description
Get or set by name a value in any of the variable groups.

### Parameters
- **name** (str) - The name of the variable.
- **optional value** (any) - The value to set, if provided.
```

--------------------------------

### Solarpilot.from_existing()

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Solarpilot.html

Creates a new instance of the Solarpilot module from an existing configuration.

```APIDOC
## Solarpilot.from_existing()

### Description
Initializes a new Solarpilot instance based on an existing configuration object.

### Method
Static Method

### Parameters
- **existing_config** (Object) - Required - The existing configuration to use for initialization.
```

--------------------------------

### CbConstructionFinancing.from_existing()

Source: https://nrel-pysam.readthedocs.io/en/main/modules/CbConstructionFinancing.html

Creates an instance of the CbConstructionFinancing module from an existing data source.

```APIDOC
## CbConstructionFinancing.from_existing()

### Description
Initializes the CbConstructionFinancing module using data from an existing PySAM object or data structure.
```

--------------------------------

### PvGetShadeLossMpp.value

Source: https://nrel-pysam.readthedocs.io/en/main/modules/PvGetShadeLossMpp.html

Gets or sets a value for a specific variable in the simulation.

```APIDOC
## PvGetShadeLossMpp.value(name, value)

### Description
Get or set by name a value in any of the variable groups.

### Parameters
- **name** (string) - Required - The name of the variable.
- **value** (any) - Optional - The value to assign to the variable.
```

--------------------------------

### PySAM.MsptSfAndRecIsolated.value

Source: https://nrel-pysam.readthedocs.io/en/main/modules/MsptSfAndRecIsolated.html

Gets or sets a value for a specific variable by name.

```APIDOC
## value(name, optional value)

### Description
Get or set a value in any of the variable groups by name.

### Parameters
- **name** (string) - Required - The name of the variable.
- **optional value** (float|dict|sequence|str) - Optional - The value to assign to the variable.
```

--------------------------------

### PySAM.Grid.from_existing(data, optional config)

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Grid.html

Initializes a Grid instance by sharing data with an existing PySAM class. If an optional configuration name is provided, it loads the module's defaults for that configuration.

```APIDOC
## PySAM.Grid.from_existing(data, optional config)

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

### Parameters
- **data** (object) - Required - The existing PySAM class data.
- **optional config** (string) - Optional - A valid configuration name to load module defaults.
```

--------------------------------

### EtesElectricResistance.value

Source: https://nrel-pysam.readthedocs.io/en/main/modules/EtesElectricResistance.html

Gets or sets a specific variable value by name.

```APIDOC
## value(name, optional_value)

### Description
Get or set a value in any of the variable groups by its name.

### Parameters
- **name** (str) - Required - The name of the variable.
- **optional_value** (any) - Optional - The value to set for the variable.
```

--------------------------------

### Geothermal.value

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Geothermal.html

Gets or sets a specific variable value by name.

```APIDOC
## value(name, value=None)

### Description
Retrieves or updates a variable value within any of the variable groups.

### Parameters
- **name** (str) - Required - The name of the variable.
- **value** (float|dict|sequence|str) - Optional - The value to set.
```

--------------------------------

### CspSubcomponent Initialization Methods

Source: https://nrel-pysam.readthedocs.io/en/main/modules/CspSubcomponent.html

Methods for creating or wrapping a CspSubcomponent instance.

```APIDOC
## PySAM.CspSubcomponent.default(config)
### Description
Load defaults for the configuration.

## PySAM.CspSubcomponent.from_existing(data, optional config)
### Description
Share data with an existing PySAM class.

## PySAM.CspSubcomponent.new()
### Description
Create a new instance.

## PySAM.CspSubcomponent.wrap(ssc_data_t)
### Description
Load data from a PySSC object.
```

--------------------------------

### PySAM.CbConstructionFinancing.value

Source: https://nrel-pysam.readthedocs.io/en/main/modules/CbConstructionFinancing.html

Gets or sets a value for a specific variable by name.

```APIDOC
## value(name, optional value)

### Description
Get or set a value in any of the variable groups by its name.

### Parameters
- **name** (string) - Required - The name of the variable.
- **value** (float|dict|sequence|str) - Optional - The value to assign to the variable.
```

--------------------------------

### Wfreader.execute(verbosity)

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Wfreader.html

Executes the simulation.

```APIDOC
## Wfreader.execute(verbosity)

### Description
Execute simulation with verbosity level 0 (default) or 1.
```

--------------------------------

### TroughPhysicalIph.value(name, optional value)

Source: https://nrel-pysam.readthedocs.io/en/main/modules/TroughPhysicalIph.html

Gets or sets a value by name.

```APIDOC
## TroughPhysicalIph.value(name, optional value)

### Description
Get or set by name a value in any of the variable groups.

### Parameters
- **name** (string) - Required - The name of the variable.
- **optional value** (float | dict | sequence | str) - Optional - The value to set.
```

--------------------------------

### PySAM.Wfreader.from_existing(data, optional config)

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Wfreader.html

Shares data with an existing PySAM class and optionally loads defaults.

```APIDOC
## PySAM.Wfreader.from_existing(data, optional config)

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

--------------------------------

### Windbos.value(name, optional value)

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Windbos.html

Gets or sets a value by name.

```APIDOC
## Windbos.value(name, optional value)

### Description
Get or set by name a value in any of the variable groups.
```

--------------------------------

### WindFileReader.from_existing()

Source: https://nrel-pysam.readthedocs.io/en/main/modules/WindFileReader.html

Creates a WindFileReader instance from an existing data source or configuration.

```APIDOC
## WindFileReader.from_existing()

### Description
Initializes a WindFileReader using an existing data structure or file reference.

### Method
Static Method
```

--------------------------------

### PySAM.HostDeveloper.from_existing

Source: https://nrel-pysam.readthedocs.io/en/main/modules/HostDeveloper.html

Initializes a HostDeveloper instance by sharing data with an existing PySAM class.

```APIDOC
## PySAM.HostDeveloper.from_existing(data, optional_config)

### Description
Shares data with an existing PySAM class. Optionally loads module defaults if a valid configuration name is provided.

### Parameters
- **data** (object) - Required - The existing data object.
- **optional_config** (string) - Optional - A valid configuration name to load defaults.
```

--------------------------------

### Wfcheck.value(name, optional_value)

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Wfcheck.html

Get or set a variable value by name.

```APIDOC
## Wfcheck.value(name, optional_value)

### Description
Get or set by name a value in any of the variable groups.

### Parameters
- **name** (str) - Required - The name of the variable.
- **optional_value** (any) - Optional - The value to set.
```

--------------------------------

### PySAM.Timeseq.value

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Timeseq.html

Gets or sets a value for a specific variable within the simulation.

```APIDOC
## Timeseq.value(name, optional_value)

### Description
Retrieves or updates the value of a variable by name.

### Parameters
- **name** (string) - Required - The name of the variable.
- **optional_value** (float|dict|sequence|str) - Optional - The value to set.
```

--------------------------------

### Create Conda environment

Source: https://nrel-pysam.readthedocs.io/en/main/_sources/pyssc-for-dao-tk.rst.txt

Initialize a new Python 3.7 environment for DAO-Tk.

```bash
conda create --name pysam_daotk python=3.7 -y
```

--------------------------------

### Get internal data pointer

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Communitysolar.html

Retrieve the underlying ssc_data_t pointer.

```python
get_data_ptr() → Pointer
```

--------------------------------

### Sco2CspSystem Initialization Methods

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Sco2CspSystem.html

Methods for creating or wrapping an instance of the Sco2CspSystem compute module.

```APIDOC
## Sco2CspSystem Initialization

### Methods
- `default()`: Creates an instance of the module with default values.
- `from_existing(existing_instance)`: Creates an instance from an existing PySSC object.
- `new()`: Creates a new instance of the module.
- `wrap(ssc_data)`: Wraps an existing SSC data object into the module.
```

--------------------------------

### Initialize Communitysolar model

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Communitysolar.html

Methods for creating or loading a Communitysolar instance.

```python
PySAM.Communitysolar.default(_config_) → Communitysolar
```

```python
PySAM.Communitysolar.from_existing(_data_ , _optional config_) → Communitysolar
```

```python
PySAM.Communitysolar.new() → Communitysolar
```

```python
PySAM.Communitysolar.wrap(_ssc_data_t_) → Communitysolar
```

--------------------------------

### Sco2AirCooler.value(name, optional value)

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Sco2AirCooler.html

Gets or sets a value by name.

```APIDOC
## Sco2AirCooler.value(name, optional value)

### Description
Gets or sets a value in any of the variable groups by name.
```

--------------------------------

### Sco2CompCurves.value(name, value)

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Sco2CompCurves.html

Gets or sets a simulation variable by name.

```APIDOC
## Sco2CompCurves.value(name, value)

### Description
Retrieves or assigns a value to a specific simulation variable.

### Parameters
- **name** (str) - Required - The name of the variable.
- **value** (float|dict|sequence|str) - Optional - The value to assign to the variable.
```

--------------------------------

### Swh Module Initialization Methods

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Swh.html

Methods for initializing the Swh compute module instance.

```APIDOC
## Swh Initialization Methods

### Description
Methods to create or wrap an instance of the Swh compute module.

### Methods
- `default()`: Creates an instance with default values.
- `from_existing(existing_instance)`: Creates an instance from an existing object.
- `new()`: Creates a new instance.
- `wrap(ssc_data)`: Wraps existing SSC data into the Swh module interface.
```

--------------------------------

### Irradproc.value(name, optional value)

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Irradproc.html

Gets or sets a value by name.

```APIDOC
## Irradproc.value(name, optional value)

### Description
Get or set by name a value in any of the variable groups.
```

--------------------------------

### Equpartflip Initialization Methods

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Equpartflip.html

Methods used to initialize the Equpartflip module instance.

```APIDOC
## Equpartflip Initialization

### Description
Methods to create or wrap an instance of the Equpartflip compute module.

### Methods
- `default()`: Creates an instance with default values.
- `from_existing(existing)`: Creates an instance from an existing object.
- `new()`: Creates a new instance.
- `wrap(ssc_data)`: Wraps existing SSC data into the Equpartflip module.
```

--------------------------------

### Iec61853par.value

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Iec61853par.html

Gets or sets a variable value within the simulation groups.

```APIDOC
## Iec61853par.value(name, optional_value)

### Description
Retrieves or updates the value of a specific variable by name across any of the variable groups.

### Parameters
- **name** (str) - Required - The name of the variable.
- **optional_value** (float|dict|sequence|str) - Optional - The value to set for the variable.
```

--------------------------------

### Pvwattsv51ts Methods

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Pvwattsv51ts.html

Methods for initializing and managing the Pvwattsv51ts compute module instance.

```APIDOC
## Pvwattsv51ts Methods

### default()
Creates a new instance of the Pvwattsv51ts module with default values.

### from_existing(data)
Creates a new instance of the Pvwattsv51ts module using existing data.

### new()
Creates a new instance of the Pvwattsv51ts module.

### wrap(ssc_data_ptr)
Wraps an existing SSC data pointer into a Pvwattsv51ts instance.
```

--------------------------------

### HybridGenerator.value

Source: https://nrel-pysam.readthedocs.io/en/main/_sources/hybrids/HybridGenerator.rst.txt

Gets or sets a value for a specific variable group by name.

```APIDOC
## value(name, value=None)

### Description
Get or set by name a value in any of the variable groups.

### Parameters
- **name** (str) - Required - The name of the variable.
- **value** (float | dict | sequence | str) - Optional - The value to set.

### Returns
- **None | float | dict | sequence | str** - The current value if setting to None, otherwise None.
```

--------------------------------

### Initialize Windbos Module

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Windbos.html

Methods for creating a new Windbos instance, loading defaults, or wrapping existing data.

```python
PySAM.Windbos.default(_config_) → Windbos
```

```python
PySAM.Windbos.from_existing(_data_ , _optional config_) → Windbos
```

```python
PySAM.Windbos.new() → Windbos
```

```python
PySAM.Windbos.wrap(_ssc_data_t_) → Windbos
```

--------------------------------

### FresnelPhysicalIph Initialization Methods

Source: https://nrel-pysam.readthedocs.io/en/main/modules/FresnelPhysicalIph.html

Methods to initialize the FresnelPhysicalIph compute module.

```APIDOC
## FresnelPhysicalIph Initialization

### Methods
- **default()**: Creates an instance of the module with default values.
- **from_existing(data)**: Creates an instance from existing data.
- **new()**: Creates a new instance of the module.
- **wrap(data)**: Wraps existing data into the module structure.
```

--------------------------------

### PySAM.WindObos.value(name, optional_value)

Source: https://nrel-pysam.readthedocs.io/en/main/modules/WindObos.html

Gets or sets a value for a specific variable by name.

```APIDOC
## PySAM.WindObos.value(name, optional_value)

### Description
Retrieves or updates the value of a variable within the simulation groups.

### Parameters
- **name** (str) - Required - The name of the variable.
- **optional_value** (float|dict|sequence|str) - Optional - The value to set for the variable.
```

--------------------------------

### Hcpv Module Initialization

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Hcpv.html

Methods for creating or wrapping an Hcpv simulation instance.

```APIDOC
## Hcpv Initialization Methods

### default()
Creates an instance of the Hcpv module with default values.

### from_existing(existing_instance)
Creates an instance of the Hcpv module from an existing instance.

### new()
Creates a new instance of the Hcpv module.

### wrap(ssc_data_ptr)
Wraps an existing SSC data pointer into an Hcpv module instance.
```

--------------------------------

### UiUdpcChecks.value(name, optional_value)

Source: https://nrel-pysam.readthedocs.io/en/main/modules/UiUdpcChecks.html

Gets or sets a value in any of the variable groups by name.

```APIDOC
## UiUdpcChecks.value(name, optional_value)

### Description
Get or set by name a value in any of the variable groups.

### Parameters
- **name** (string) - Required - The name of the variable.
- **optional_value** (float|dict|sequence|str) - Optional - The value to set for the variable.
```

--------------------------------

### Wfcsvconv.value(name, value)

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Wfcsvconv.html

Gets or sets a variable value in the Wfcsvconv module.

```APIDOC
## Wfcsvconv.value(name, value)

### Description
Retrieves or assigns a value to a specific variable within the module's variable groups.

### Parameters
- **name** (str) - Required - The name of the variable to get or set.
- **value** (float|dict|sequence|str) - Optional - The value to assign to the variable.
```

--------------------------------

### PySAM.Utilityrate5.from_existing

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Utilityrate5.html

Initializes a Utilityrate5 instance by sharing data with an existing PySAM class or loading defaults from a configuration.

```APIDOC
## PySAM.Utilityrate5.from_existing(data, optional config)

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

### Parameters
- **data** (object) - Required - The existing PySAM class data.
- **optional config** (string) - Optional - A valid configuration name to load defaults.

### Returns
- **Utilityrate5** - An instance of the Utilityrate5 class.
```

--------------------------------

### TcslinearFresnel.value

Source: https://nrel-pysam.readthedocs.io/en/main/modules/TcslinearFresnel.html

Gets or sets a variable value by name within the simulation groups.

```APIDOC
## value(name, value)

### Description
Get or set by name a value in any of the variable groups.

### Parameters
- **name** (str) - Required - The name of the variable.
- **value** (float | dict | sequence | str) - Optional - The value to assign to the variable.
```

--------------------------------

### Change directory to development path

Source: https://nrel-pysam.readthedocs.io/en/main/_sources/pyssc-for-dao-tk.rst.txt

Navigate to the local directory containing the SAM development files.

```bash
cd path/to/sam_dev/
```

--------------------------------

### Run a PVWatts model using exported SAM inputs

Source: https://nrel-pysam.readthedocs.io/en/main/_sources/getting-started.rst.txt

Loads configuration data from a JSON file generated by SAM, sets the model inputs, executes the simulation, and prints the annual AC output.

```python
import json
import PySAM.Pvwattsv8 as pv # import the PVWatts module from PySAM

# create a new instance of the Pvwattsv8 module
pv_model = pv.new()

# get the inputs from the JSON file
with open( 'untitled_pvwattsv8.json', 'r') as f:
        pv_inputs = json.load( f )

# iterate through the input key-value pairs and set the module inputs
for k, v in pv_inputs.items():
    if k != 'number_inputs':
        pv_model.value(k, v)

# run the module
pv_model.execute()

# print results
print('Annual AC output for {capacity:,.2f} kW system is {output:,.0f} kWh.\n'.format(capacity = pv_model.value('system_capacity'), output = pv_model.Outputs.ac_annual) )
```

--------------------------------

### ThermalrateIph.value(name, optional value)

Source: https://nrel-pysam.readthedocs.io/en/main/modules/ThermalrateIph.html

Gets or sets a variable value by name.

```APIDOC
## ThermalrateIph.value(name, optional value)

### Description
Retrieves or updates the value of a variable within the simulation groups.

### Parameters
- **name** (str) - Required - The name of the variable.
- **optional value** (float|dict|sequence|str) - Optional - The value to assign to the variable.
```

--------------------------------

### PySAM.Snowmodel.value(name, optional_value)

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Snowmodel.html

Gets or sets a specific variable value by name.

```APIDOC
## PySAM.Snowmodel.value(name, optional_value)

### Description
Retrieves or updates a variable value within the simulation groups.

### Parameters
- **name** (string) - Required - The name of the variable.
- **optional_value** (any) - Optional - The value to set for the variable.
```

--------------------------------

### PvGetShadeLossMpp.execute

Source: https://nrel-pysam.readthedocs.io/en/main/modules/PvGetShadeLossMpp.html

Executes the PV shade loss simulation.

```APIDOC
## PvGetShadeLossMpp.execute(verbosity)

### Description
Execute the simulation with the specified verbosity level.

### Parameters
- **verbosity** (int) - Required - Verbosity level (0 for default, 1 for verbose).
```

--------------------------------

### PySAM.Singlediode.value(name, optional_value)

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Singlediode.html

Gets or sets a value in any of the variable groups by name.

```APIDOC
## PySAM.Singlediode.value(name, optional_value)

### Description
Get or set by name a value in any of the variable groups.

### Parameters
- **name** (string) - Required - The name of the variable.
- **optional_value** (float | dict | sequence | str) - Optional - The value to set if provided.
```

--------------------------------

### TroughPhysicalIph Initialization Methods

Source: https://nrel-pysam.readthedocs.io/en/main/modules/TroughPhysicalIph.html

Methods used to initialize the TroughPhysicalIph compute module.

```APIDOC
## TroughPhysicalIph Initialization

### Methods
- **default()**: Creates an instance of the module with default values.
- **from_existing(data)**: Creates an instance from existing data.
- **new()**: Creates a new instance of the module.
- **wrap(ssc_data)**: Wraps existing SSC data into the module.
```

--------------------------------

### PySAM.Pvwattsv51ts.value(name, optional_value)

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Pvwattsv51ts.html

Gets or sets a value in any of the variable groups by name.

```APIDOC
## PySAM.Pvwattsv51ts.value(name, optional_value)

### Description
Get or set by name a value in any of the variable groups.

### Parameters
- **name** (string) - Required - The name of the variable.
- **optional_value** (float|dict|sequence|str) - Optional - The value to set if provided.
```

--------------------------------

### LinearFresnelDsgIph.value

Source: https://nrel-pysam.readthedocs.io/en/main/modules/LinearFresnelDsgIph.html

Gets or sets a specific variable value within the simulation model.

```APIDOC
## LinearFresnelDsgIph.value(name, value)

### Description
Retrieves or updates the value of a simulation variable by its name.

### Parameters
- **name** (str) - Required - The name of the variable.
- **value** (float|dict|sequence|str) - Optional - The value to assign to the variable.
```

--------------------------------

### PySAM.HostDeveloper.new

Source: https://nrel-pysam.readthedocs.io/en/main/modules/HostDeveloper.html

Creates a new instance of the HostDeveloper class.

```APIDOC
## PySAM.HostDeveloper.new()

### Description
Creates a new, empty instance of the HostDeveloper class.
```

--------------------------------

### Pvsandiainv.from_existing()

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Pvsandiainv.html

Creates an instance of the Pvsandiainv model from an existing data source.

```APIDOC
## Pvsandiainv.from_existing()

### Description
Creates an instance of the Pvsandiainv model using data from an existing model instance.
```

--------------------------------

### PtesDesignPoint.value(name, value)

Source: https://nrel-pysam.readthedocs.io/en/main/modules/PtesDesignPoint.html

Gets or sets a value for a specific variable by name.

```APIDOC
## PtesDesignPoint.value(name, value)

### Description
Get or set by name a value in any of the variable groups.

### Parameters
- **name** (str) - Required - The name of the variable.
- **value** (float|dict|sequence|str) - Optional - The value to assign to the variable.
```

--------------------------------

### PySAM.FresnelPhysicalIph.value(name, optional_value)

Source: https://nrel-pysam.readthedocs.io/en/main/modules/FresnelPhysicalIph.html

Gets or sets a value by name in any of the variable groups.

```APIDOC
## PySAM.FresnelPhysicalIph.value(name, optional_value)

### Description
Get or set by name a value in any of the variable groups.

### Parameters
- **name** (str) - Required - The name of the variable.
- **optional_value** (float | dict | sequence | str) - Optional - The value to set if provided.
```

--------------------------------

### PySAM.HybridSteps.value(name, value)

Source: https://nrel-pysam.readthedocs.io/en/main/modules/HybridSteps.html

Get or set a value in any of the variable groups by name.

```APIDOC
## PySAM.HybridSteps.value(name, value)

### Description
Get or set by name a value in any of the variable groups.

### Parameters
- **name** (string) - Required - The name of the variable.
- **value** (float|dict|sequence|str) - Optional - The value to set.
```

--------------------------------

### ThermalrateIph Methods

Source: https://nrel-pysam.readthedocs.io/en/main/modules/ThermalrateIph.html

Methods for initializing the ThermalrateIph compute module.

```APIDOC
## ThermalrateIph Methods

### default()
Creates an instance of the ThermalrateIph module with default values.

### from_existing(existing_instance)
Creates an instance of the ThermalrateIph module from an existing instance.

### new()
Creates a new instance of the ThermalrateIph module.

### wrap(ssc_data_ptr)
Wraps an existing SSC data pointer into a ThermalrateIph instance.
```

--------------------------------

### Utilityrateforecast Initialization

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Utilityrateforecast.html

Methods to initialize a new Utilityrateforecast instance.

```APIDOC
## Initialization Methods

### PySAM.Utilityrateforecast.default(config)
Load defaults for the configuration `config`.

### PySAM.Utilityrateforecast.from_existing(data, optional config)
Share data with an existing PySAM class.

### PySAM.Utilityrateforecast.new()
Create a new Utilityrateforecast instance.

### PySAM.Utilityrateforecast.wrap(ssc_data_t)
Load data from a PySSC object.
```

--------------------------------

### PySAM.Hybrid.value(name, optional_value)

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Hybrid.html

Gets or sets a value for a specific variable by name.

```APIDOC
## PySAM.Hybrid.value(name, optional_value)

### Description
Get or set by name a value in any of the variable groups.

### Parameters
- **name** (string) - Required - The name of the variable.
- **optional_value** (float|dict|sequence|str) - Optional - The value to set if provided.
```

--------------------------------

### PySAM.Wfcsvconv.new()

Source: https://nrel-pysam.readthedocs.io/en/main/modules/Wfcsvconv.html

Creates a new instance of the Wfcsvconv module.

```APIDOC
## PySAM.Wfcsvconv.new()

### Description
Creates a new instance of the Wfcsvconv class for configuring and running a weather file conversion simulation.

### Returns
- **Wfcsvconv** (object) - A new instance of the Wfcsvconv module.
```
Tokens:
Raw