PySAM

PySAM is a Python package for the National Renewable Energy Laboratory’s System Advisor Model (SAM). It is part of the SAM Software Development Kit (SDK), which provides tools for developers who write code that interacts with the SAM Simulation Core (SSC) application programming interface (API). PySAM is built on the PySSC wrapper for SSC.

To use PySAM successfully, you should be familiar enough with SAM to create and run models, and to identify the names of input and output variables.

Contents

• Installing PySAM
  • PyPI
• Getting Started
  • Example 1: Build a Model from SAM
  • Example 2: Build a Model from Defaults
• PySAM Overview
• PySAM Versions
  • Version 6.0.0
  • Version 5.1.0
  • Version 5.0.0
  • Version 4.2.0
  • Version 4.1.0
  • Version 4.0.0
  • Version 3.0.2
  • Version 3.0.1
  • Version 3.0.0
• Importing Inputs from SAM
  • SAM Code Generator
  • PySAM JSON
  • JSON for Inputs
• Accessing SAM Defaults
• Working with Variables
  • Get a variable’s value
  • Set a variable value
  • Get and Set Variable Values by Group
• Identifying Variables
• Interdependent Variables
  • Finding Relationships between Variables
  • Calculated Values in SAM
  • Examples
• PySAM Functions
• Helper Functions (Tools)
  • Resource Tools
  • Battery Tools
  • Load Tools
  • Utility Rate Tools
• Code Examples
  • Generate Inputs for a REopt API Call
• Getting Help
• Working Directly with PySSC
  • Use SAM’s Code Generator for PySSC
  • Debug SSC from Python using Visual Studio
  • PySSC description
• Building PySAM for NREL DAO-Tk
  • Compile only a Linux SSC library file (libssc.so) when using PySSC instead of PySAM
  • Install the DAO-Tk Version of PySAM (in a fresh environment)
  • Test the DAO-Tk Version of PySAM in VS Code
  • Creating a DAO-Tk Version of PySAM: Windows and Linux Builds
• Building PySAM from Source
• List of SAM Configurations
  • Biomass Combustion – LCOE Calculator (FCR Method)
  • Biomass Combustion – Merchant Plant
  • Biomass Combustion – No Financial Model
  • Biomass Combustion – Partnership Flip with Debt
  • Biomass Combustion – Partnership Flip without Debt
  • Biomass Combustion – Sale Leaseback
  • Biomass Combustion – Single Owner
  • Custom Generation PVWatts Wind Fuel Cell Battery Hybrid – Single Owner
  • Custom Generation PVWatts Wind Fuel Cell Battery Hybrid – Third Party - Host / Developer
  • Custom Generation Profile (Generic System) – Commercial Owner
  • Custom Generation Profile (Generic System) – LCOE Calculator (FCR Method)
  • Custom Generation Profile (Generic System) – Merchant Plant
  • Custom Generation Profile (Generic System) – No Financial Model
  • Custom Generation Profile (Generic System) – Partnership Flip with Debt
  • Custom Generation Profile (Generic System) – Partnership Flip without Debt
  • Custom Generation Profile (Generic System) – Residential Owner
  • Custom Generation Profile (Generic System) – Sale Leaseback
  • Custom Generation Profile (Generic System) – Single Owner
  • Custom Generation Profile (Generic System) – Third Party - Host / Developer
  • Custom Generation Profile (Generic System) – Third Party Owner - Host
  • Custom Generation Profile-Battery (Generic Battery) – Commercial Owner
  • Custom Generation Profile-Battery (Generic Battery) – Merchant Plant
  • Custom Generation Profile-Battery (Generic Battery) – Partnership Flip with Debt
  • Custom Generation Profile-Battery (Generic Battery) – Partnership Flip without Debt
  • Custom Generation Profile-Battery (Generic Battery) – Residential Owner
  • Custom Generation Profile-Battery (Generic Battery) – Sale Leaseback
  • Custom Generation Profile-Battery (Generic Battery) – Single Owner
  • Custom Generation Profile-Battery (Generic Battery) – Third Party - Host / Developer
  • Custom Generation Profile-Battery (Generic Battery) – Third Party Owner - Host
  • Detailed PV Model – Commercial Owner
  • Detailed PV Model – LCOE Calculator (FCR Method)
  • Detailed PV Model – Merchant Plant
  • Detailed PV Model – No Financial Model
  • Detailed PV Model – Partnership Flip with Debt
  • Detailed PV Model – Partnership Flip without Debt
  • Detailed PV Model – Residential Owner
  • Detailed PV Model – Sale Leaseback
  • Detailed PV Model – Single Owner
  • Detailed PV Model – Third Party - Host / Developer
  • Detailed PV Model – Third Party Owner - Host
  • Detailed PV-Battery – Commercial Owner
  • Detailed PV-Battery – Merchant Plant
  • Detailed PV-Battery – Partnership Flip with Debt
  • Detailed PV-Battery – Partnership Flip without Debt
  • Detailed PV-Battery – Residential Owner
  • Detailed PV-Battery – Sale Leaseback
  • Detailed PV-Battery – Single Owner
  • Detailed PV-Battery – Third Party - Host / Developer
  • Detailed PV-Battery – Third Party Owner - Host
  • Electric Thermal Energy Storage – Single Owner
  • Fuel Cell - PV - Battery – Commercial Owner
  • Fuel Cell - PV - Battery – Single Owner
  • Generic Solar Model – Commercial Owner
  • Generic Solar Model – LCOE Calculator (FCR Method)
  • Generic Solar Model – Merchant Plant
  • Generic Solar Model – No Financial Model
  • Generic Solar Model – Partnership Flip with Debt
  • Generic Solar Model – Partnership Flip without Debt
  • Generic Solar Model – Sale Leaseback
  • Generic Solar Model – Single Owner
  • Geothermal – LCOE Calculator (FCR Method)
  • Geothermal – Merchant Plant
  • Geothermal – No Financial Model
  • Geothermal – Partnership Flip with Debt
  • Geothermal – Partnership Flip without Debt
  • Geothermal – Sale Leaseback
  • Geothermal – Single Owner
  • High Concentration PV – LCOE Calculator (FCR Method)
  • High Concentration PV – Merchant Plant
  • High Concentration PV – No Financial Model
  • High Concentration PV – Partnership Flip with Debt
  • High Concentration PV – Partnership Flip without Debt
  • High Concentration PV – Sale Leaseback
  • High Concentration PV – Single Owner
  • Linear Direct Steam –
  • Linear Direct Steam – No Financial Model
  • Linear Direct Steam – Single Owner
  • Linear Fresnel Direct Steam – Commercial Owner
  • Linear Fresnel Direct Steam – LCOE Calculator (FCR Method)
  • Linear Fresnel Direct Steam – Merchant Plant
  • Linear Fresnel Direct Steam – No Financial Model
  • Linear Fresnel Direct Steam – Partnership Flip with Debt
  • Linear Fresnel Direct Steam – Partnership Flip without Debt
  • Linear Fresnel Direct Steam – Sale Leaseback
  • Linear Fresnel Direct Steam – Single Owner
  • Linear Fresnel Molten Salt – Merchant Plant
  • Linear Fresnel Molten Salt – Partnership Flip with Debt
  • Linear Fresnel Molten Salt – Partnership Flip without Debt
  • Linear Fresnel Molten Salt – Sale Leaseback
  • Linear Fresnel Molten Salt – Single Owner
  • Linear Molten Salt –
  • Linear Molten Salt – Commercial Owner
  • Linear Molten Salt – No Financial Model
  • Linear Molten Salt – Single Owner
  • PVWatts – Commercial Owner
  • PVWatts – Community Solar
  • PVWatts – LCOE Calculator (FCR Method)
  • PVWatts – Merchant Plant
  • PVWatts – No Financial Model
  • PVWatts – Partnership Flip with Debt
  • PVWatts – Partnership Flip without Debt
  • PVWatts – Residential Owner
  • PVWatts – Sale Leaseback
  • PVWatts – Single Owner
  • PVWatts – Third Party - Host / Developer
  • PVWatts – Third Party Owner - Host
  • PVWatts Wind Battery Hybrid – Single Owner
  • PVWatts Wind Battery Hybrid – Third Party - Host / Developer
  • PVWatts Wind Fuel Cell Battery Hybrid – Single Owner
  • PVWatts Wind Fuel Cell Battery Hybrid – Third Party - Host / Developer
  • PVWatts-Battery – Commercial Owner
  • PVWatts-Battery – Residential Owner
  • PVWatts-Battery – Third Party - Host / Developer
  • PVWatts-Battery – Third Party Owner - Host
  • Parabolic Trough –
  • Parabolic Trough – Commercial Owner
  • Parabolic Trough – No Financial Model
  • Parabolic Trough – Single Owner
  • Parabolic Trough Empirical Model – Commercial Owner
  • Parabolic Trough Empirical Model – LCOE Calculator (FCR Method)
  • Parabolic Trough Empirical Model – Merchant Plant
  • Parabolic Trough Empirical Model – No Financial Model
  • Parabolic Trough Empirical Model – Partnership Flip with Debt
  • Parabolic Trough Empirical Model – Partnership Flip without Debt
  • Parabolic Trough Empirical Model – Sale Leaseback
  • Parabolic Trough Empirical Model – Single Owner
  • Parabolic Trough Physical Model – Commercial Owner
  • Parabolic Trough Physical Model – LCOE Calculator (FCR Method)
  • Parabolic Trough Physical Model – Merchant Plant
  • Parabolic Trough Physical Model – No Financial Model
  • Parabolic Trough Physical Model – Partnership Flip with Debt
  • Parabolic Trough Physical Model – Partnership Flip without Debt
  • Parabolic Trough Physical Model – Sale Leaseback
  • Parabolic Trough Physical Model – Single Owner
  • Photovoltaic Wind Battery Hybrid – Single Owner
  • Photovoltaic Wind Battery Hybrid – Third Party - Host / Developer
  • Power Tower Molten Salt – Merchant Plant
  • Power Tower Molten Salt – No Financial Model
  • Power Tower Molten Salt – Partnership Flip with Debt
  • Power Tower Molten Salt – Partnership Flip without Debt
  • Power Tower Molten Salt – Sale Leaseback
  • Power Tower Molten Salt – Single Owner
  • Pumped Thermal Energy Storage – Single Owner
  • Solar Water Heating – Commercial Owner
  • Solar Water Heating – LCOE Calculator (FCR Method)
  • Solar Water Heating – No Financial Model
  • Solar Water Heating – Residential Owner
  • Standalone Battery – Commercial Owner
  • Standalone Battery – Merchant Plant
  • Standalone Battery – Partnership Flip with Debt
  • Standalone Battery – Partnership Flip without Debt
  • Standalone Battery – Residential Owner
  • Standalone Battery – Sale Leaseback
  • Standalone Battery – Single Owner
  • Standalone Battery – Third Party - Host / Developer
  • Standalone Battery – Third Party Owner - Host
  • Tidal – LCOE Calculator (FCR Method)
  • Tidal – No Financial Model
  • Tower Molten Salt –
  • Tower Molten Salt – No Financial Model
  • Tower Molten Salt – Single Owner
  • Wave – LCOE Calculator (FCR Method)
  • Wave – No Financial Model
  • Wave – Single Owner
  • Wave Battery – Single Owner
  • Wind – Commercial Owner
  • Wind – LCOE Calculator (FCR Method)
  • Wind – Merchant Plant
  • Wind – No Financial Model
  • Wind – Partnership Flip with Debt
  • Wind – Partnership Flip without Debt
  • Wind – Residential Owner
  • Wind – Sale Leaseback
  • Wind – Single Owner
• List of SSC Compute Modules
• Hybrid Systems
  • HybridGenerator
  • HybridSystem
  • Available modules
  • Accessing and setting variables
  • Creating models