# Modules¶

## Simulation Module Names and Descriptions¶

The modules with “SAM Desktop” names are used in the SAM GUI’s technology-financial simulations.

The modules without a “SAM Desktop” entry provide helper functions or are older versions of above modules.

Technical help documentation for the SAM models is available from the SAM Help Website.

PySAM Module | SAM Desktop | Description |
---|---|---|

Annualoutput | Annual Output | |

Battery | Battery | Battery storage standalone model . |

BatteryStateful | Battery management system model with state | |

Battwatts | simple battery model | |

Belpe | Belpe | Estimates an electric load profile given basic building characteristics and a weather file |

Biomass | Biopower | Utility scale wind farm model (adapted from TRNSYS code by P.Quinlan and openWind software by AWS Truepower) |

Cashloan | Residential/Commerical Finance model. | |

CbConstructionFinancing | Construction financing cost calculations | |

CbEmpiricalHceHeatLoss | Empirical HCE Heat Loss | |

CbMsptSystemCosts | CSP molten salt power tower system costs | |

Communitysolar | CommunitySolar | Comunity Solar Financial Model |

DsgFluxPreprocess | Calculate receiver max flux and absorber (boiler, etc.) fractions | |

Equpartflip | AllEquityPartnershipFlip | All Equity Partnership Flip Financial Model |

EtesElectricResistance | ETES | Electric resistance heater charging TES from grid, discharge with power cycle |

Fuelcell | FuelCell | Fuel cell model |

GenericSystem | GenericSystem | Generic System |

Geothermal | GeothermalPower | Geothermal monthly and hourly models using general power block code from TRNSYS Type 224 code by M.Wagner, and some GETEM model code. |

GeothermalCosts | Geothermal monthly and hourly models using general power block code from TRNSYS Type 224 code by M.Wagner, and some GETEM model code. | |

Grid | Grid model | |

Hcpv | HighXConcentratingPV | High-X Concentrating PV, SAM component models V.1 |

HostDeveloper | HostDeveloper | Host Developer Financial Model |

Iec61853interp | Determine single diode model parameters from IEC 61853 solution matrix at a given temperature and irradiance. | |

Iec61853par | Calculate 11-parameter single diode model parameters from IEC-61853 PV module test data. | |

InvCecCg | CEC Inverter Coefficient Generator | |

IphToLcoefcr | LCOHCalculator | Convert annual energy to kWt-hr and adjust fixed cost to include electric parasitic costs. |

Ippppa | Utility IPP/Commerical PPA Finance model. | |

Irradproc | Irradiance Processor | |

IsccDesignPoint | Calculates design point inject, extraction, fossil output | |

Layoutarea | Layout Area Calculation | |

Lcoefcr | LCOECalculator | Calculate levelized cost of energy using fixed charge rate method. |

Levpartflip | LeveragedPartnershipFlip | Leveraged Partnership Flip Financial Model |

LinearFresnelDsgIph | DSGLIPH | CSP model using the linear fresnel TCS types. |

Merchantplant | Single Owner Financial Model | |

MhkCosts | Calculates various cost categories for Marine Energy arrays for different device types. | |

MhkTidal | MHK Tidal power calculation model using power distribution. | |

MhkWave | MHK Wave power calculation model using power distribution. | |

Poacalib | Calibrates beam and diffuse to give POA input | |

Pv6parmod | CEC 6 Parameter PV module model performance calculator. Does not include weather file reading or irradiance processing, or inverter (DC to AC) modeling. | |

PvGetShadeLossMpp | PV get shade loss fraction for strings | |

Pvsamv1 | FlatPlatePV | Photovoltaic performance model, SAM component models V.1 |

Pvsandiainv | Sandia PV inverter performance calculator. | |

Pvwattsv1 | PVWatts V.1 - integrated hourly weather reader and PV system simulator. | |

Pvwattsv11ts | pvwattsv1_1ts- single timestep calculation of PV system performance. | |

Pvwattsv1Poa | PVWatts system performance calculator. Does not include weather file reading or irradiance processing - user must supply arrays of precalculated POA irradiance data. | |

Pvwattsv5 | PVWatts V5 - integrated hourly weather reader and PV system simulator. | |

Pvwattsv51ts | pvwattsv5_1ts- single timestep calculation of PV system performance. | |

Pvwattsv7 | PVWatts V7 - integrated hourly weather reader and PV system simulator. | |

Pvwattsv8 | PVWatts | PVWatts V8 - integrated hourly weather reader and PV system simulator. |

Saleleaseback | SaleLeaseback | Sale Leaseback Financial Model |

Sco2AirCooler | Returns air cooler dimensions given fluid and location design points | |

Sco2CompCurves | Calls sCO2 auto-design cycle function | |

Sco2CspSystem | … | |

Sco2CspUdPcTables | … | |

Singlediode | Single diode model function. | |

Singlediodeparams | Single diode model parameter calculation. | |

Singleowner | SingleOwner | Single Owner Financial Model |

Snowmodel | Estimates the Detrimental Effects due to Snow Fall | |

Solarpilot | SolarPILOT - CSP tower solar field layout tool. | |

Swh | SolarWaterHeating | Solar water heating model using multi-mode tank node model. |

TcsgenericSolar | GenericCSPSystem | Generic CSP model using the generic solar TCS types. |

TcslinearFresnel | DSLF | CSP model using the linear fresnel TCS types. |

TcsmoltenSalt | MSPT | CSP molten salt power tower with hierarchical controller and dispatch optimization |

TcsMSLF | MSLF | CSP model using the molten salt linear fresnel TCS types. |

TcstroughEmpirical | EmpiricalTrough | CSP model using the emperical trough TCS types. |

TcstroughPhysical | CSP model using the emperical trough TCS types. | |

TestUdPowerCycle | Test user-defined power cylce model | |

Thermalrate | Thermal flat rate structure net revenue calculator | |

Thirdpartyownership | ThirdParty | Residential/Commercial 3rd Party Ownership Finance model. |

Timeseq | Time sequence generator | |

TroughPhysical | PhysicalTrough | Physical trough applications |

TroughPhysicalCspSolver | Physical trough using CSP Solver | |

TroughPhysicalProcessHeat | PhysicalTroughIPH | Physical trough process heat applications |

UiTesCalcs | Calculates values for all calculated values on UI TES page(s) | |

UiUdpcChecks | Calculates the levels and number of paramteric runs for 3 udpc ind variables | |

UserHtfComparison | Evaluates equivalence of two user-defined HTF tables | |

Utilityrate | Complex utility rate structure net revenue calculator | |

Utilityrate2 | Complex utility rate structure net revenue calculator OpenEI Version 2 | |

Utilityrate3 | Complex utility rate structure net revenue calculator OpenEI Version 3 | |

Utilityrate4 | Complex utility rate structure net revenue calculator OpenEI Version 4 | |

Utilityrate5 | Utilityrate5 | Complex utility rate structure net revenue calculator OpenEI Version 4 with net billing |

WaveFileReader | SAM Wave Resource File Reader | |

Wfcheck | Weather file checker. | |

Wfcsvconv | Converter for TMY2, TMY3, INTL, EPW, SMW weather files to standard CSV format | |

Wfreader | Standard Weather File Format Reader (TMY2, TMY3, EPW, SMW, WFCSV) | |

WindFileReader | SAM Wind Resource File Reader (SRW) | |

WindObos | Wind Offshore Balance of System cost model | |

Windbos | Wind Balance of System cost model | |

Windcsm | WISDEM turbine cost model | |

Windpower | WindPower | Utility scale wind farm model (adapted from TRNSYS code by P.Quinlan and openWind software by AWS Truepower) |

6parsolve | Solver for CEC/6 parameter PV module coefficients |