PySAM

A Python package for the National Renewable Energy Laboratory’s System Advisor Model.
https://github.com/natlabrockies/pysam

Category: Energy Systems
Sub Category: Energy System Modeling Frameworks

Keywords from Contributors

photovoltaics renewables renewable-energy bifacial radiance solar-energy

Last synced: about 21 hours ago
JSON representation

Repository metadata

Python Wrapper for the System Advisor Model

README.md

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.9 - 3.13, 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, < 6.0.0 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 Laboratory of the Rockies. Golden, CO. Accessed . https://github.com/NatLabRockies/pysam


Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 11 days ago

Total Commits: 704
Total Committers: 21
Avg Commits per committer: 33.524
Development Distribution Score (DDS): 0.456

Commits in past year: 206
Committers in past year: 6
Avg Commits per committer in past year: 34.333
Development Distribution Score (DDS) in past year: 0.131

Name Email Commits
dguittet d****t@n****v 383
Steven Janzou s****n@j****m 189
Brian Mirletz b****z@n****v 39
Paul Gilman c****n@g****m 33
Matt Prilliman 5****n 23
frohro r****e@w****u 10
Ben Elliston b****e@a****u 9
Kevin Anderson k****n@n****v 2
Janine Keith j****n 2
Greg Miller 4****r 2
Cliff Hansen c****e@s****v 2
Mike Welch m****h@t****y 1
Nick DiOrio n****o@n****v 1
Allen Downey d****y@a****m 1
Bill Hamilton 3****d 1
Dakota Sky Ramos 8****s 1
João Bastos j****5@g****m 1
MasonBowen t****n@n****v 1
Matthew Boyd 3****d 1
Sam Koebrich s****h@N****v 1
Silvana Ovaitt s****a@n****v 1

Committer domains:


Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 11
Total pull requests: 19
Average time to close issues: 3 months
Average time to close pull requests: 19 days
Total issue authors: 6
Total pull request authors: 6
Average comments per issue: 0.82
Average comments per pull request: 0.63
Merged pull request: 16
Bot issues: 0
Bot pull requests: 0

Past year issues: 11
Past year pull requests: 18
Past year average time to close issues: 3 months
Past year average time to close pull requests: 20 days
Past year issue authors: 6
Past year pull request authors: 6
Past year average comments per issue: 0.82
Past year average comments per pull request: 0.67
Past year merged pull request: 15
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/natlabrockies/pysam

Top Issue Authors

  • brtietz (5)
  • mjprilliman (2)
  • tylernisonoff (1)
  • vincentlogarzo (1)
  • Peque (1)
  • sjanzou (1)

Top Pull Request Authors

  • brtietz (7)
  • sjanzou (5)
  • dguittet (3)
  • mjprilliman (2)
  • joaopaulosr95 (1)
  • cpaulgilman (1)

Top Issue Labels

  • bug (3)
  • good first issue (2)

Top Pull Request Labels

  • bug (1)

Dependencies

.github/workflows/linter.yml actions
  • actions/checkout v2 composite
  • docker://github/super-linter v2.1.1 composite
docs/requirements.txt pypi
  • NREL-PySAM *
  • pandas *
  • sphinx_rtd_theme *
requirements.txt pypi
  • pandas *
  • python-dotenv *
  • requests *
tests/requirements.txt pypi
  • mypy * test
  • numpy * test
  • pandas * test
  • pympler * test
  • pytest * test
  • python-dotenv * test
  • requests * test
Examples/PVPMC_pvlib_PySAM_example/requirements.txt pypi
  • NREL-PySAM ==5.1.0
  • openpyxl ==3.0.10
  • pvlib ==0.10.4
  • pvmismatch ==4.1
  • scipy ==1.11.4
Examples/green_button_data_example/requirements.txt pypi
  • NREL-PySAM *
  • certifi *
  • greenbutton_objects *
  • pandas *
  • requests *
setup.py pypi
.github/workflows/ci-macos.yml actions
  • actions/cache v6 composite
  • actions/checkout v7 composite
  • conda-incubator/setup-miniconda v4 composite
  • jwlawson/actions-setup-cmake v2 composite
.github/workflows/ci-windows.yml actions
  • actions/cache v6 composite
  • actions/checkout v7 composite
  • conda-incubator/setup-miniconda v4 composite
  • microsoft/setup-msbuild v3 composite
pyproject.toml pypi
  • requests *
.github/workflows/ci-linux.yml actions
  • actions/cache v6 composite
  • actions/checkout v7 composite
  • conda-incubator/setup-miniconda v4 composite
  • jwlawson/actions-setup-cmake v2 composite

Score: 8.174421152646497