National Renewable Energy Laboratory's System Advisor Model Python Wrapper


License
BSD-3-Clause
Install
pip install NREL-PySAM==5.1.0

Documentation

PySAM Package

https://nrel-pysam.readthedocs.io

  • Provides a wrapper around the SAM library that groups together the C API functions by technology or financial model into modules.
  • Includes error-checking, explicit input and output definition, and conversion between Python data types.
  • PySAM modules are compatible with PySSC, which is included as a subpackage. PySSC is the original wrapper used by SAM's code generator.
  • Automatically assign default values to input parameters from SAM's default value database.
  • Built-in documentation of models and parameters.

Requirements

  1. Python 3.8 - 3.12, 64 bit
  2. Operating system:
    • MacOSX 10.7+
    • Most Linux
    • Windows 7, x64
  3. CMake 3.20+

Installing

  1. PyPi:

    pip install nrel-pysam
    
  2. Anaconda (Versions > 1.2.1 only):

    conda install -c nrel nrel-pysam
    

May not be compatible with different builds of the CPython reference interpreter, and not with alternative interpreters such as PyPy, IronPython or Jython

Usage Examples

Citing this package

PySAM . National Renewable Energy Laboratory. Golden, CO. Accessed . https://github.com/nrel/pysam