https://github.com/hoarelea/sam

Sustainable Analytical Model (SAM) - Core
https://github.com/hoarelea/sam

core sam

Last synced: 3 months ago
JSON representation

Sustainable Analytical Model (SAM) - Core

• Host: GitHub
• URL: https://github.com/hoarelea/sam
• Owner: HoareLea
• License: lgpl-3.0
• Created: 2019-11-27T20:31:07.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2026-01-11T11:17:23.000Z (4 months ago)
• Last Synced: 2026-02-06T15:47:30.557Z (3 months ago)
• Topics: core, sam
• Language: C#
• Homepage:
• Size: 8.5 MB
• Stars: 20
• Watchers: 5
• Forks: 8
• Open Issues: 50
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Notice: NOTICE

Awesome Lists containing this project

README

          
[![Build (Windows)](https://github.com/SAM-BIM/SAM/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/SAM-BIM/SAM/actions/workflows/build.yml)

[![Installer (latest)](https://img.shields.io/github/v/release/SAM-BIM/SAM_Deploy?label=installer)](https://github.com/SAM-BIM/SAM_Deploy/releases/latest)

# SAM



  



**SAM (Sustainable Analytical Model)** is the core of the **SAM Toolkit** —  

an open-source platform designed to help engineers create, manage,

and analyse analytical building models for energy and environmental performance.

SAM provides a structured analytical representation of buildings,

supporting workflows for energy modelling, systems analysis,

environmental simulation, and performance-driven design.

It is designed as a **modular and extensible platform**:

core analytical concepts are implemented in this repository,

with additional functionality provided through specialised SAM modules

and integrations.

---

## What SAM provides

At its core, SAM enables:

- creation and management of analytical building models  

- assignment of constructions, loads, and system definitions  

- preparation of models for simulation and analysis  

- orchestration of analytical workflows and scenarios  

- integration with external tools and simulation engines  

SAM supports both **programmatic** and **visual** workflows,

including integration with environments such as **Grasshopper**, **Rhino**, and **Revit**.

---

## Extensibility

The SAM platform is intentionally modular.

Additional repositories provide functionality such as:

- simulation engine integrations (e.g. Tas, OpenStudio)

- data exchange formats (IFC, gbXML, GEM)

- environmental and physical calculations (psychrometrics, solar, acoustics)

- UI layers and scripting interfaces (Windows UI, Rhino, Python)

- experimental and research workflows

The full ecosystem, module descriptions, and relationships

are documented in the **SAM Wiki**.

---

## Getting started

To install **SAM**, download and run the  

[latest Windows installer](https://github.com/SAM-BIM/SAM_Deploy/releases/latest).

Alternatively, the toolkit can be built from source using Visual Studio.

See the documentation in the **SAM Wiki** for setup guidance and build details.

---

## Documentation

📘 **SAM Wiki:**  

https://github.com/SAM-BIM/SAM/wiki

The Wiki contains:

- module overviews and relationships  

- build and dependency information  

- workflow examples  

- developer and contributor guidance  

---

## Licence

This repository is free software licensed under the  

**GNU Lesser General Public License v3.0 or later (LGPL-3.0-or-later)**.

Each contributor retains copyright to their respective contributions.  

The project history (Git) records authorship and provenance of all changes.

See:

- `LICENSE`

- `NOTICE`

- `COPYRIGHT_HEADER.txt`