{"id":17793436,"url":"https://github.com/open-pv/simshady","last_synced_at":"2025-03-16T19:30:48.896Z","repository":{"id":229666913,"uuid":"755025061","full_name":"open-pv/simshady","owner":"open-pv","description":"Simulating Shadows for PV Potential Analysis on 3D Data in the Browser :sunny:","archived":false,"fork":false,"pushed_at":"2024-08-30T16:11:14.000Z","size":357,"stargazers_count":6,"open_issues_count":2,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-09-12T11:03:20.106Z","etag":null,"topics":["pv","pv-simulator","shading-effects","solar","solar-energy","threejs"],"latest_commit_sha":null,"homepage":"https://open-pv.github.io/simshady/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/open-pv.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-02-09T09:25:17.000Z","updated_at":"2024-09-04T05:51:32.000Z","dependencies_parsed_at":"2024-04-22T09:59:26.873Z","dependency_job_id":"82760ce3-a292-40be-9485-82bbdd3f769a","html_url":"https://github.com/open-pv/simshady","commit_stats":null,"previous_names":["open-pv/simshady","open-pv/simulation"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-pv%2Fsimshady","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-pv%2Fsimshady/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-pv%2Fsimshady/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-pv%2Fsimshady/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/open-pv","download_url":"https://codeload.github.com/open-pv/simshady/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240712964,"owners_count":19845580,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["pv","pv-simulator","shading-effects","solar","solar-energy","threejs"],"created_at":"2024-10-27T11:08:52.744Z","updated_at":"2025-03-16T19:30:48.871Z","avatar_url":"https://github.com/open-pv.png","language":"TypeScript","funding_links":[],"categories":["Renewable Energy"],"sub_categories":["Photovoltaics and Solar Energy"],"readme":"![Tests](https://github.com/open-pv/simshady/actions/workflows/tests.yml/badge.svg) ![Docs](https://github.com/open-pv/simshady/actions/workflows/typedoc.yml/badge.svg) [![NPM Version](https://img.shields.io/npm/v/@openpv/simshady)](https://www.npmjs.com/package/@openpv/simshady) [![NPM Downloads](https://img.shields.io/npm/dm/@openpv/simshady)](https://npmtrends.com/@openpv/simshady)\n\n# SimShady\n\nSimShady 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](https://openpv.de).\n\n## Installation\n\nTo install the package, run\n\n```\nnpm i @openpv/simshady\n```\n\n## Usage\n\nWe 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](https://github.com/open-pv/minimalApp).\n\nThe basic usage of the package works as follows:\n\n```javascript\nimport ShadingScene from '@openpv/simshady';\n\nconst lat = 50.0;\nconst lon = 11.0;\nconst scene = new ShadingScene(lat, lon);\nscene.addShadingGeometry(someShadingGeometry);\nscene.addSimulationGeometry(someSimulationGeometry);\n\nlet mesh = await scene.calculate({\n    numberSimulations: 100,\n    diffuseIrradiance: \"https://www.openpv.de/data/irradiance\",\n    urlDirectIrrandianceTIF:\n      \"https://www.openpv.de/data/irradiance/geotiff/average_direct_radiation.tif\",\n    urlDiffuseIrrandianceTIF:\n      \"https://www.openpv.de/data/irradiance/geotiff/average_diffuse_radiation.tif\",\n});\n\nshowThreeJS(mesh);\n```\n\n## Team\n\n\u003ctable\u003e\n\u003ctr\u003e\n    \u003ctd align=\"center\" style=\"word-wrap: break-word; width: 150.0; height: 150.0\"\u003e\n        \u003ca href=https://github.com/MartGro\u003e\n            \u003cimg src=https://avatars.githubusercontent.com/u/14249622?v=4 width=\"100;\"  style=\"border-radius:50%;align-items:center;justify-content:center;overflow:hidden;padding-top:10px\" alt=MartGro /\u003e\n            \u003cbr /\u003e\n            \u003csub style=\"font-size:14px\"\u003e\u003cb\u003eMartGro\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\" style=\"word-wrap: break-word; width: 150.0; height: 150.0\"\u003e\n        \u003ca href=https://github.com/khdlr\u003e\n            \u003cimg src=https://avatars.githubusercontent.com/u/9249838?v=4 width=\"100;\"  style=\"border-radius:50%;align-items:center;justify-content:center;overflow:hidden;padding-top:10px\" alt=khdlr/\u003e\n            \u003cbr /\u003e\n            \u003csub style=\"font-size:14px\"\u003e\u003cb\u003eKonrad Heidler\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\" style=\"word-wrap: break-word; width: 150.0; height: 150.0\"\u003e\n        \u003ca href=https://github.com/FlorianK13\u003e\n            \u003cimg src=https://avatars.githubusercontent.com/u/74312290?v=4 width=\"100;\"  style=\"border-radius:50%;align-items:center;justify-content:center;overflow:hidden;padding-top:10px\" alt=Florian Kotthoff/\u003e\n            \u003cbr /\u003e\n            \u003csub style=\"font-size:14px\"\u003e\u003cb\u003eFlorian Kotthoff\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\" style=\"word-wrap: break-word; width: 150.0; height: 150.0\"\u003e\n        \u003ca href=https://github.com/kpoeppel\u003e\n            \u003cimg src=https://avatars.githubusercontent.com/u/37810656?v=4 width=\"100;\"  style=\"border-radius:50%;align-items:center;justify-content:center;overflow:hidden;padding-top:10px\" alt=kpoeppel /\u003e\n            \u003cbr /\u003e\n            \u003csub style=\"font-size:14px\"\u003e\u003cb\u003ekpoeppel\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n\u003c/tr\u003e\n\u003c/table\u003e\n\n## Contributing\n\nYou 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](https://github.com/open-pv/simshady/blob/main/CONTRIBUTING.md).\n\n## Sponsors\n\nWe thank our sponsors.\n\n\u003ca href=\"https://prototypefund.de/\"\u003e\n  \u003cimg src='https://github.com/open-pv/.github/assets/74312290/9dfa1ce4-adaf-4638-9cbc-e519b033331b' width='300'\u003e\n\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-pv%2Fsimshady","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopen-pv%2Fsimshady","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-pv%2Fsimshady/lists"}