NREL/SAM NREL/SAM

  • Stars
    star
    338
  • Rank 124,931 (Top 3 %)
  • Language
    C++
  • License
    BSD 3-Clause "New...
  • Created almost 12 years ago
  • Updated about 1 month ago
Twitter logo Share LinkedIn logo Share Facebook logo Share
NREL/SAM
github

NREL

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

System Advisor Model (SAM)

System Advisor Model (SAM)

Build FOSSA Status

The SAM Open Source Project repository contains the source code, tools, and instructions to build a desktop version of the National Renewable Energy Laboratory's System Advisor Model (SAM). SAM is a simulation program for electricity generation projects. It has models for different kinds of renewable energy systems and financial models for residential, commercial, and utility-scale projects. For more details about SAM's capabilities, see the SAM website at https://sam.nrel.gov/.

For a short video describing the SAM repositories, see https://youtu.be/E5z1iiZfZ3M.

The SAM release notes are in https://github.com/NREL/SAM/blob/gh-pages/doc/releasenotes.html.

The desktop version of SAM for Windows, Mac, or Linux builds from the following open source projects:

  • SSC is a set of "compute modules" that simulate different kinds of power systems and financial structures. It can be run directly using the SAM Software Development Kit. This is the source code for SAM's models, and is the repository to use for researching the algorithms underlying the models.

  • LK is a scripting language that is integrated into SAM. SAM's user interface uses LK to calculate values to display on input pages. The user interface includes a script editor that allows users to write their own scripts from the user interface.

  • wxWidgets is a cross-platform graphical user interface platform used for SAM's user interface, and for the development tools included with SSC (SDKtool) and LK (LKscript). The current version of SAM uses wxWidgets 3.1.5.

  • WEX is a set of extensions to wxWidgets for custom user-interface elements developed specifically for SAM, LK script, and DView.

  • Google Test is a C++ test framework that enables comprehensive unit-testing of software. Contributions to the project will eventually be required to have associated unit tests written in this framework.

  • jsoncpp is a C++ library that allows manipulating JSON values, including serialization and deserialization to and from strings.

  • Python/Miniconda is for integration of Python scripts with the SAM user interface.

This repository, SAM, contains the code for SAM's user interface that assigns values to inputs of the SSC compute modules, runs the modules in the correct order, and displays simulation results. It also includes tools for editing LK scripts, viewing time series results, and generating shade data from a 3-dimensional representation of a photovoltaic array or solar hot water collector and nearby shading objects.

The SAM repository also includes two libraries from Sandia National Laboratories, stepwise, and LHS, which are distributed as part of the Dakota platform, licensed under LGPL.

Quick Steps for Building SAM

For detailed build instructions see the wiki with specific instructions for:

These are the general quick steps you need to follow to set up your computer for developing SAM:

  1. Set up your development tools:

  2. Download the wxWidgets 3.1.5 source code for your operating system from https://www.wxwidgets.org/downloads/.

  3. Build wxWidgets.

  4. In Windows, create the WXMSW3 environment variable on your computer to point to the wxWidgets installation folder, or in MacOS and Linux, create the dynamic link /usr/<USERNAME>/local/bin/wx-config-3 to point to /path/to/wxWidgets/bin/wx-config.

  5. As you did for wxWidgets, for each of the following projects, clone (download) the repository, build the project, and then (Windows only) create an environment variable pointing to the project folder. Build the projects in the following order, and assign the environment variable for each project before you build the next one:

ProjectRepository URLWindows Environment Variable
LKhttps://github.com/NREL/lkLKDIR
WEXhttps://github.com/NREL/wexWEXDIR
SSChttps://github.com/NREL/sscSSCDIR
SAMhttps://github.com/NREL/SAMSAMNTDIR
Google Testhttps://github.com/google/googletestGTEST

Contributing

If you would like to report an issue with SAM or make a feature request, please let us know by adding a new issue on the issues page.

If you would like to submit code to fix an issue or add a feature, you can use GitHub to do so. Please see Contributing for instructions.

License

SAM's open source code is copyrighted by the Alliance for Sustainable Energy and licensed with BSD-3-Clause terms, found here.

The stepwise and LHS LGPL licensed libraries from Sandia National Laboratories are pre-compiled Fortran libraries that are included in the SAM repository as binaries in the Sandia folder. You can replace the binaries with different versions by compiling your own version and replacing the binary/executable viles in the Sandia folder.

Citing this package

System Advisor Model Version 2022.11.21 (2022). SAM source code. National Renewable Energy Laboratory. Golden, CO. Accessed November 28, 2022. https://github.com/NREL/SAM

More Repositories

1

api-umbrella

Open source API management platform
Ruby
1,944
star
2

EnergyPlus

EnergyPlusâ„¢ is a whole building energy simulation program that engineers, architects, and researchers use to model both energy consumption and water use in buildings.
C++
1,117
star
3

OpenStudio

OpenStudio is a cross-platform collection of software tools to support whole building energy modeling using EnergyPlus and advanced daylight analysis using Radiance.
C++
502
star
4

floris

A controls-oriented engineering wake model.
Python
208
star
5

OpenOA

This library provides a framework for assessing wind plant performance using operational assessment (OA) methodologies that consume time series data from wind plants. The goal of the project is to provide an open source implementation of common data structures, analysis methods, and utility functions relevant to wind plant OA.
Jupyter Notebook
185
star
6

Radiance

This repo has been archived. Please refer to https://github.com/LBNL-ETA/Radiance/tree/master for the latest updates.
C
156
star
7

rdtools

PV Analysis Tools in Python
Python
153
star
8

vagrant-boxes

Shell
146
star
9

SOWFA

Roff
133
star
10

ReEDS-2.0

Python
125
star
11

pysam

Python Wrapper for the System Advisor Model
C
108
star
12

HPC

A collection of various resources, examples, and executables for the general NREL HPC user community's benefit. Use the following website for accessing documentation.
Jupyter Notebook
107
star
13

resstock

Highly granular modeling of residential building stocks at national, regional, and local scales using OpenStudio/EnergyPlus.
Ruby
105
star
14

ROSCO

A Reference Open Source Controller for Wind Turbines
Python
105
star
15

PowerGridworld

PowerGridworld provides users with a lightweight, modular, and customizable framework for creating power-systems-focused, multi-agent Gym environments that readily integrate with existing training frameworks for reinforcement learning (RL). https://arxiv.org/abs/2111.05969
Python
102
star
16

reV

Renewable Energy Potential (reV) Model
Python
101
star
17

hsds-examples

Examples of using the HSDS Service to Access NREL WIND Toolkit data
Jupyter Notebook
100
star
18

REopt_API

The model for the REopt API, which is used as the back-end for the REopt Webtool (reopt.nrel.gov/tool), and can be accessed directly via the NREL Developer Network (https://developer.nrel.gov/docs/energy-optimization/reopt)
Python
89
star
19

bifacial_radiance

Toolkit for working with RADIANCE for the ray-trace modeling of Bifacial Photovoltaics
Python
89
star
20

openstudio-standards

Ruby
81
star
21

sup3r

The Super-Resolution for Renewable Resource Data (sup3r) software uses generative adversarial networks to create synthetic high-resolution wind and solar spatiotemporal data from coarse low-resolution inputs.
Python
80
star
22

ssc

SAM Simulation Core (SSC) contains the underlying performance and financial models for SAM
C++
79
star
23

phygnn

physics-guided neural networks (phygnn)
Python
74
star
24

ditto

DiTTo is a Distribution Transformation Tool that aims at providing an open source framework to convert various distribution systems modeling formats.
Python
69
star
25

floorspace.js

JavaScript
68
star
26

mappymatch

Pure-python package for map matching
Python
66
star
27

EvoProtGrad

Directed evolution of proteins in sequence space with gradients
Jupyter Notebook
60
star
28

PhIRE

Python
58
star
29

dgen

The Distributed Generation Market Demand (dGen) model simulates customer adoption of distributed energy resources (DERs) for residential, commercial, and industrial entities in the United States and other countries.
Python
58
star
30

BuildingsBench

Large-scale pretraining and benchmarking for short-term load forecasting.
Jupyter Notebook
55
star
31

wex

WEX, which is short for WxWidgets Extensions, is a cross-platform library of graphical user interface tools that extends the popular open-source project WxWidgets. WEX includes many features including the powerful DView program (https://github.com/NREL/wex/wiki/DView), which provides an easy-to-use way to visualize complex time series data.
C
55
star
32

turbine-models

Documentation for the turbine models in this repository is available below.
Python
54
star
33

nfp

Keras layers for end-to-end learning with rdkit and pymatgen
Python
52
star
34

alfabet

Machine learning predictions of bond dissociation energy
Python
52
star
35

WindSE

Python
51
star
36

ParaEMT_public

Python
50
star
37

BuildingMOTIF

Building Metadata OnTology Interoperability Framework (BuildingMOTIF). For models, see https://models.open223.info/
Jupyter Notebook
49
star
38

SolarPILOT

SolarPILOT power tower layout and optimization tool
C++
46
star
39

dynamo

A modular MATLAB toolkit for Dynamic programming (DP) and Approximate Dynamic Programming (ADP) for Adaptive Modeling and Optimization
MATLAB
45
star
40

OpenStudio-server

The OpenStudio Server is a docker or Helm deployable instance which allows for large-scale parametric analyses of building energy models using the OpenStudio or URBANopt CLIs.
Ruby
45
star
41

PRAS

NREL's Probabilistic Resource Adequacy Suite (PRAS)
Julia
44
star
42

developer.nrel.gov

An issue tracker for NREL's APIs available at https://developer.nrel.gov
HTML
43
star
43

gdx-pandas

Python interface to read and write GAMS GDX files using pandas.DataFrames as the intermediate data format.
Python
43
star
44

alfalfa

Alfalfa is a web service that enables runtime interaction with building energy models (OpenStudio/EnergyPlus and FMUs compiled from Modelica or Spawn) over REST APIs.
Python
42
star
45

OpenStudio-HPXML

Modeling of residential buildings in EnergyPlus using OpenStudio/HPXML.
Ruby
41
star
46

OCHRE

A Python-based building energy modeling (BEM) tool designed to model flexible loads in residential buildings
Python
40
star
47

graph-env

Reinforcement learning for combinatorial optimization over directed graphs
Python
38
star
48

elm

ELM is a collection of utilities to apply Large Language Models (LLMs) to energy research.
Python
37
star
49

OPFLearn.jl

A Julia package that efficiently creates representative datasets for machine learning approaches to AC optimal power flow
Julia
37
star
50

PyPSCAD

36
star
51

PV_ICE

An open-source tool to quantify Solar Photovoltaics (PV) Energy and Mass Flows in the Circular Economy, from a Reliability and Lifetime approach
HTML
34
star
52

windtools

Python tools for wind simulation setup, data processing, and analysis
Python
34
star
53

PyDSS

Python
33
star
54

SolTrace

SolTrace
C++
33
star
55

MATBOX_Microstructure_analysis_toolbox

MATBOX is an open-source MATLAB toolbox dedicated to microstructure analsyis of porous/heterogeneous materials
MATLAB
32
star
56

REopt-Analysis-Scripts

Jupyter Notebook
32
star
57

OpenStudio-analysis-spreadsheet

The OpenStudio Analysis Spreadsheet is a front-end for the OpenStudio Server, allowing for users to create large-scale cloud analyses using OpenStudio measures.
Ruby
31
star
58

flasc

A rich floris-driven suite for SCADA analysis
Jupyter Notebook
31
star
59

SOWFA-6

31
star
60

lk

LK (Language Kit) is a simple but powerful scripting language that is designed to be small, fast, and easily embedded in other applications. The core LK engine, including lexical analyzer, parser, compiler, and virtual machine is only dependent on the Standard C++ Library (STL), making it extremely lightweight and portable.
C
31
star
61

rlmolecule

A reinforcement learning library for material and molecule optimization
Python
30
star
62

GEOPHIRES-v2

GEOPHIRES v2.0: a free and open-source geothermal techno-economic simulator
Python
30
star
63

bifacialvf

Bifacial PV View Factor model for system performance calculation
Python
29
star
64

openfast-turbine-models

A repository of OpenFAST turbine models developed by NREL researchers.
Jupyter Notebook
29
star
65

ATB-calc

Python files and Jupyter notebooks for processing the Annual Technology Baseline (ATB) electricity data and determining LCOE and other metrics.
Python
29
star
66

MoorPy

Python
28
star
67

EnergyPlusRelease

Fortran
27
star
68

ComStock

National scale modeling of the U.S. commercial building stock supported by U.S. DOE, LADWP, and others and maintained by NREL
Ruby
27
star
69

PVDegradationTools

Set of tools to calculate degradation responses and degradation related parameters for PV.
Jupyter Notebook
27
star
70

OpenStudio-PAT

The Parametric Analysis Tool (PAT) is part of the OpenStudio collection of software tools.
Ruby
27
star
71

m2p

Python
26
star
72

DSS-SimPy-RL

This repository is an Reinforcement Learning Platform for learning agents to control cyber-physical Power Distribution Systems resiliently. The cyber environment in based on SimPy Discrete Event Simulator, while the distribution system is backened by Open-DSS.
Python
25
star
73

BACnet

Java
24
star
74

REopt.jl

Julia
24
star
75

api-umbrella-gatekeeper

See the https://github.com/NREL/api-umbrella repository instead.
JavaScript
23
star
76

HOPP

Jupyter Notebook
22
star
77

api-umbrella-web

See the https://github.com/NREL/api-umbrella repository instead.
Ruby
22
star
78

OpenWARP

Please visit http://nrel.github.io/OpenWARP/ for more information.
Python
22
star
79

ROSCO_toolbox

A repository for generating ROSCO controller input files and more.
Python
22
star
80

hive

HIVEâ„¢ is a mobility services research platform
Python
22
star
81

buildstockbatch

Python
21
star
82

PyPSSE

Python
21
star
83

Panel-Segmentation

This open-source package provides a framework for automatically detecting and extracting metadata from solar array installations in satellite images.
Jupyter Notebook
21
star
84

reVX

The Renewable Energy Potential(V) eXchange Tool: reVX
Python
21
star
85

OpenStudio-Prototype-Buildings

Ruby
20
star
86

HydroChrono

A hydrodynamics extension for Project Chrono, enabling simulations of wave energy converters, floating offshore wind turbines, and more.
C++
20
star
87

docker-openstudio

Repository for managing the builds of OpenStudio Docker images.
Dockerfile
20
star
88

fastsim

Python
20
star
89

electrolyzer

Python
20
star
90

ProgressiveHedging.jl

Basic progressive hedging implementation in Julia
Julia
20
star
91

rex

REsource eXtraction Tool (rex)
Python
20
star
92

powerscenarios

Realistic renewable energy scenarios for stochastic grid optimization problems
MATLAB
20
star
93

hescore-hpxml

HPXML to Home Energy Score Translator
Python
18
star
94

OpenStudio-fault-measure-gem

OpenStudio measures for modeling building faults
Ruby
18
star
95

CampusEnergyModeling

MATLAB
18
star
96

latex_editing

TeX
18
star
97

OpenStudio-resources

HTML
18
star
98

OpenStudio-ERI

Energy Rating Index (ERI) calculation via OpenStudio/EnergyPlus.
Ruby
18
star
99

NRWAL

The National Renewable Energy Laboratory Wind Analysis Libray (NRWAL)
Python
17
star
100

altrios

Rust
17
star