Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@openpv/simshady

open-pv59Apache-2.00.1.1TypeScript support: included

Simulating Shadows for PV Potential Analysis on 3D Data on the GPU.

solar, photovoltaic, pv, threejs, three, webgl, gis, renewables, renewable energy

readme

Tests Docs NPM Version NPM Downloads

simshady

simshady is a package for shading simulation and PV yield estimation based on 3D meshes. It runs on the GPU using WebGL. See it in action at openpv.de.

Installation

To install the package, run

npm i @openpv/simshady

Usage

We publish our documentation at https://open-pv.github.io/simshady/. Additionally, we have built a minimal vite webapp to showcase the most relevant features. Check out its source code here.

Team

MartGro
MartGro 		khdlr
Konrad Heidler 		Florian
Florian Kotthoff 		kpoeppel
kpoeppel

Contributing

You are welcome to contribute to this project, either by adding code or creating Issues. As a first step, you might check out our contributing guidelines.

Sponsors

We thank our sponsors.

changelog

Changelog

All notable changes to this project will be documented in this file. For each version important additions, changes and removals are listed here.

The format is inspired from Keep a Changelog and the versioning aims to respect Semantic Versioning.

v0.1.0 - 2025-04-21

Changes

  • Use skydomes in the simshady simulation by @FlorianK13 in #48

v0.0.5 - 2024-09-17

Changes

  • Add keywords by @FlorianK13 in #29
  • Add Contributing.md by @FlorianK13 in #29
  • Stop hogging the main thread during calculation (No more "this website is slowing down your browser") by @khdlr in #32

Fixes

  • Fix incorrect handling of indexed geometries by @khdlr in #36
  • Fix outdated usage example in README.md by @khdlr in #37
  • Fix incorrect handling of clockwise-oriented polygons by @khdlr in #31

[v0.0.4] - 2024-08-30

Changes

  • Delete hardcoded url for tif files by @FlorianK13 in #24
  • Add units warning to docs by @FlorianK13 in #25
  • Make colormaps configurable by @FlorianK13 in #27

[v0.0.3] - 2024-08-19

Update of version number was not done in 0.0.2, so another release was needed 🥇

[v0.0.2] Bug Fixes - 2024-08-19

Changes

  • Use Diffuse Radiation in WebGL by @FlorianK13 in #15
  • Include diffuse radiation by @FlorianK13 in #18
  • Shadinggeometry should be infered from simgeometry by @FlorianK13 in #21

[v0.0.1] First NPM Release - 2024-06-03

Added

  • Add Main class ShadingScene
  • Add WebGL code for shading simulation
  • Add method for digital elevation models
  • Add method for diffuse radiation
  • Add documentation page on github pages