Open Sustainable Technology

A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

Browse accepted projects | Review proposed projects | Propose new project | Open Issues

SSC

Contains the source code for the technology and financial models contained within the National Renewable Energy Laboratory's System Advisor Model.
https://github.com/NREL/ssc

Last synced: about 1 hour ago
JSON representation

Repository metadata

SAM Simulation Core (SSC) contains the underlying performance and financial models for SAM

README

        

# SSC (SAM Simulation Core)
![Build](https://github.com/NREL/ssc/actions/workflows/ci.yml/badge.svg)
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FNREL%2Fssc.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2FNREL%2Fssc?ref=badge_shield)

The SSC Open Source Project repository contains the source code for the technology and financial models contained within the National Renewable Energy Laboratory's System Advisor Model (SAM). For more details about SAM's capabilities, see the SAM website at [https://sam.nrel.gov/](https://sam.nrel.gov).

You could think of SSC as the home for the algorithms behind the SAM desktop program. Most people run the code through the desktop user interface, but SSC can also be run directly using the [SAM Sofware Develoment Kit](https://sam.nrel.gov/sdk).

SSC requires building four other open-source projects:

- [Google Test](https://github.com/google/googletest)
- [LK](https://github.com/nrel/lk)
- [wxWidgets](https://www.wxwidgets.org/)
- [WEX](https://github.com/nrel/wex)
- [jsoncpp](https://github.com/open-source-parsers/jsoncpp)

However, if you remove SDKtool and TCSconsole from your SSC project, you can build SSC without any other software dependencies. Please see the main [SAM project wiki](https://github.com/NREL/SAM/wiki) for complete build instructions and software dependencies.

SSC directly includes source code from three other open-source projects, and builds them as part of its build process. These projects and their respective licenses are:
- [NLopt](https://nlopt.readthedocs.io/en/latest/) - code located [here](https://github.com/NREL/ssc/tree/develop/nlopt), [LGPL license](https://nlopt.readthedocs.io/en/latest/NLopt_License_and_Copyright/)
- [lp_solve](http://lpsolve.sourceforge.net/5.5/) - code located [here](https://github.com/NREL/ssc/tree/develop/lpsolve), [LGPL license](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html)
- [splinter](https://github.com/bgrimstad/splinter) - code located [here](https://github.com/NREL/ssc/tree/develop/splinter), [MPL license](https://github.com/bgrimstad/splinter/blob/master/LICENSE)

To explore the code and understand the algorithms used in SSC, start by looking in the "SSC" project at the compute modules (files starting with cmod_) to find the compute module for the technology or financial model of interest.

# Contributing

Please see the contribution guidelines in the main [SAM project readme](https://github.com/NREL/SAM/blob/develop/README.md).

# License

SSC is licensed with BSD-3-Clause terms, found [here](https://github.com/NREL/SAM/blob/develop/LICENSE).

# Citing this package

System Advisor Model Version 2023.12.17 (2023). SSC source code. National Renewable Energy Laboratory. Golden, CO. Accessed November 28, 2023. https://github.com/NREL/ssc


Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: about 4 hours ago

Total Commits: 8,816
Total Committers: 52
Avg Commits per committer: 169.538
Development Distribution Score (DDS): 0.79

Commits in past year: 318
Committers in past year: 8
Avg Commits per committer in past year: 39.75
Development Distribution Score (DDS) in past year: 0.638

Name Email Commits
Ty Neises t****s@n****v 1847
Steve Janzou s****u@n****v 1815
dguittet d****t@n****v 795
nickdiorio n****o@g****m 587
Prilliman M****n@n****v 547
Aron Dobos a****s@o****m 537
Brian Mirletz b****z@n****v 493
Nick DiOrio n****o@n****v 292
Matthew Boyd m****d@g****m 256
Michael Wagner m****r@n****v 252
Ben Elliston b****e@a****u 199
Tom Ferguson t****n@n****v 195
Janine Freeman j****n@n****v 183
Matthew Boyd m****d@n****v 162
Paul Gilman p****n@e****t 122
janinefreeman j****n@n****v 99
Paul Gilman c****n@g****m 96
Taylor Brown 6****5 50
Parangat Bhaskar p****4@g****m 48
WHamilt2 w****n@n****v 35
Ana D a****n@w****u 32
David Ryberg u****m 28
Steven Janzou s****e@j****m 15
Janna Martinek J****k@n****v 14
Kevin Anderson k****n@n****v 12
Guangdong Zhu g****u@n****v 11
Fung k****g@g****m 11
Casey Zak c****k@c****m 10
rchintala13 r****l@n****v 10
Boyd m****d@n****v 8
and 22 more...

Committer domains:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 378
Total pull requests: 793
Average time to close issues: 7 months
Average time to close pull requests: 12 days
Total issue authors: 37
Total pull request authors: 37
Average comments per issue: 1.42
Average comments per pull request: 0.78
Merged pull request: 721
Bot issues: 0
Bot pull requests: 0

Past year issues: 36
Past year pull requests: 116
Past year average time to close issues: about 1 month
Past year average time to close pull requests: 7 days
Past year issue authors: 11
Past year pull request authors: 9
Past year average comments per issue: 1.56
Past year average comments per pull request: 0.49
Past year merged pull request: 109
Past year bot issues: 0
Past year bot pull requests: 0

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

Top Issue Authors

  • brtietz (68)
  • dguittet (55)
  • janinefreeman (50)
  • nickdiorio (43)
  • Matthew-Boyd (28)
  • cpaulgilman (25)
  • mjprilliman (19)
  • sjanzou (18)
  • bje- (15)
  • mjwagner2 (12)
  • caseyzak24 (7)
  • timorichert (5)
  • tyneises (5)
  • kieranfung (3)
  • gauravumrani (2)

Top Pull Request Authors

  • brtietz (178)
  • sjanzou (104)
  • dguittet (95)
  • mjprilliman (79)
  • tyneises (67)
  • bje- (67)
  • cpaulgilman (42)
  • Matthew-Boyd (31)
  • janinefreeman (24)
  • mjwagner2 (21)
  • nickdiorio (17)
  • qualand (14)
  • kieranfung (14)
  • taylorbrown75 (6)
  • caseyzak24 (5)

Top Issue Labels

  • bug (152)
  • battery (61)
  • enhancement (55)
  • pv (39)
  • added to release notes (25)
  • csp (20)
  • wishlist (20)
  • financial (8)
  • new feature (7)
  • solarpilot (6)
  • utility rate (5)
  • wind (4)
  • architecture (3)
  • wontfix (3)
  • help wanted (2)
  • dev bug (2)
  • question (1)
  • mhk (1)

Top Pull Request Labels

  • added to release notes (166)
  • bug (113)
  • battery (86)
  • enhancement (54)
  • pv (24)
  • utility rate (13)
  • csp (11)
  • financial (9)
  • new feature (8)
  • mhk (3)
  • wind (2)
  • solarpilot (1)
  • dev bug (1)

Dependencies

.github/workflows/ci.yml actions
  • actions/checkout v2 composite
  • actions/upload-artifact v3 composite
  • jwlawson/actions-setup-cmake v1.12 composite

Score: 8.678631537293768