Data

Tools

Indexes

Applications

Experiments

Open Source Science

simshady

Simulating Shadows for PV Potential Analysis with 3D Data in the Browser :sunny:

https://github.com/open-pv/simshady

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 6 committers (16.7%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.2%) to scientific vocabulary

Keywords

pv pv-simulator shading-effects solar solar-energy threejs

Keywords from Contributors

renewable-energy renewables balkonkraftwerk chakra-ui interactive projection optim embedded genomics observability
Last synced: 6 months ago · JSON representation

Repository

Simulating Shadows for PV Potential Analysis with 3D Data in the Browser :sunny:

Basic Info
Statistics
  • Stars: 25
  • Watchers: 2
  • Forks: 3
  • Open Issues: 3
  • Releases: 7
Topics
pv pv-simulator shading-effects solar solar-energy threejs
Created about 2 years ago · Last pushed 7 months ago
Metadata Files
Readme Changelog Contributing License

README.md

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.

When to use simshady

You want to

  • build an application for solar (photovoltaic) yield estimation. These estimations tell you how much electricity a solar panel can produce at a specific location. Since this is influenced a lot by the shadows of surrounding buildings and trees, you want to have a shading simulation. Use simshady.
  • use 3D data of buildings, terrain, or trees to calculate shading. You have this data in formats that can be converted to three.js-Meshes, like .obj, .stl, or .citygml. Use simshady.

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. For major changes, please open an issue first to discuss what you would like to change. As a first step, you might check out our contributing guidelines.

Sponsors

We thank our sponsors.

Owner

  • Name: OpenPV
  • Login: open-pv
  • Kind: organization

Building the open source website openpv.de to evaluate the solar potential of your building :sunny:

GitHub Events

Total
  • Create event: 11
  • Release event: 1
  • Issues event: 16
  • Watch event: 17
  • Delete event: 11
  • Issue comment event: 8
  • Push event: 70
  • Pull request review event: 1
  • Pull request event: 23
  • Fork event: 3
Last Year
  • Create event: 11
  • Release event: 1
  • Issues event: 16
  • Watch event: 17
  • Delete event: 11
  • Issue comment event: 8
  • Push event: 70
  • Pull request review event: 1
  • Pull request event: 23
  • Fork event: 3

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 240
  • Total Committers: 6
  • Avg Commits per committer: 40.0
  • Development Distribution Score (DDS): 0.225
Past Year
  • Commits: 128
  • Committers: 6
  • Avg Commits per committer: 21.333
  • Development Distribution Score (DDS): 0.203
Top Committers
Name Email Commits
Florian Kotthoff 7****3 186
Konrad Heidler k****r@t****e 36
dependabot[bot] 4****] 9
Korbinian Pöppel k****p@k****e 6
martin m****n@s****e 2
MartGro g****i@n****e 1
Committer Domains (Top 20 + Academic)
nurfuerspam.de: 1 science-space.de: 1 korbip.de: 1 tum.de: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 32
  • Total pull requests: 42
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 17 days
  • Total issue authors: 4
  • Total pull request authors: 4
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.19
  • Merged pull requests: 39
  • Bot issues: 0
  • Bot pull requests: 14
Past Year
  • Issues: 14
  • Pull requests: 32
  • Average time to close issues: 3 months
  • Average time to close pull requests: 19 days
  • Issue authors: 3
  • Pull request authors: 4
  • Average comments per issue: 0.64
  • Average comments per pull request: 0.09
  • Merged pull requests: 30
  • Bot issues: 0
  • Bot pull requests: 12
View more stats
Top Authors
Issue Authors
  • FlorianK13 (23)
  • khdlr (5)
  • MartGro (3)
  • spacekookie (1)
Pull Request Authors
  • FlorianK13 (33)
  • dependabot[bot] (20)
  • khdlr (7)
  • kpoeppel (2)
Top Labels
Issue Labels
documentation (3) bug (2) enhancement (1)
Pull Request Labels
dependencies (20) javascript (2)

Packages

  • Total packages: 2
  • Total downloads:
    • npm 64 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 14
  • Total maintainers: 2
proxy.golang.org: github.com/open-pv/simshady
  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago
npmjs.org: @openpv/simshady

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

  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 64 Last month
Rankings
Dependent repos count: 32.0%
Average: 38.9%
Dependent packages count: 45.9%
Maintainers (2)
floko k.heidler
Last synced: 6 months ago

Dependencies

.github/workflows/typedoc.yml actions
  • actions/checkout v4 composite
  • actions/deploy-pages v4 composite
  • actions/setup-node v4 composite
  • actions/upload-pages-artifact v3 composite
package.json npm
  • @jest/globals ^29.7.0 development
  • @types/suncalc ^1.9.2 development
  • @types/three ^0.161.2 development
  • @types/webgl2 ^0.0.11 development
  • eslint ^8.57.0 development
  • husky ^9.0.11 development
  • jest ^29.7.0 development
  • lint-staged ^15.2.2 development
  • prettier ^3.2.5 development
  • ts-jest ^29.1.2 development
  • ts-node ^10.9.2 development
  • tsup ^8.0.1 development
  • typedoc ^0.25.9 development
  • typedoc-plugin-coverage ^3.1.0 development
  • typedoc-plugin-mdn-links ^3.1.17 development
  • typedoc-plugin-rename-defaults ^0.7.0 development
  • typescript ^5.3.3 development
  • vitest ^1.2.2 development
  • gl-matrix ^3.4.3
  • jsdoc ^4.0.2
  • suncalc ^1.9.0
  • three ^0.161.0
yarn.lock npm
  • 577 dependencies
.github/workflows/publish.yml actions
  • actions/checkout v4 composite
  • actions/setup-node v4 composite
.github/workflows/tests.yml actions
  • actions/checkout v4 composite
  • actions/setup-node v4 composite