bifacial_radiance

bifacial_radiance: a python package for modeling bifacial solar photovoltaic systems - Published in JOSS (2020)

https://github.com/nrel/bifacial_radiance

Science Score: 93.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
    Found 7 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: ieee.org, joss.theoj.org, zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

bifacial gui photovoltaics radiance renewable-energy renewables

Keywords from Contributors

photovoltaic solar-energy mesh
Last synced: 6 months ago · JSON representation

Repository

Toolkit for working with RADIANCE for the ray-trace modeling of Bifacial Photovoltaics

Basic Info
Statistics
  • Stars: 97
  • Watchers: 17
  • Forks: 56
  • Open Issues: 83
  • Releases: 26
Topics
bifacial gui photovoltaics radiance renewable-energy renewables
Created about 8 years ago · Last pushed 9 months ago
Metadata Files
Readme License

README.md

logo

bifacial_radiance

Main branch: Build Status Coverage Status Documentation Status DOI status

Development branch: Build Status Coverage Status Documentation Status

Introduction

bifacial_radiance contains a series of Python wrapper functions to make working with RADIANCE easier, particularly for the PV researcher interested in bifacial PV performance. For more information, check out our documentation, Tutorials in the form of Jupyter Notebooks, or reffer to our Wiki and Issues page.

Installation

https://youtu.be/4A9GocfHKyM This video shows how to install the bifacial_radiance software and all associated software needed. More info on the Wiki. Instructions are also shown below.

For detailed instructions of how to install bifacial_radiance, you can also refer to the installation guide

GUI!

A GUI has been added in version 3.0. The GUI reads/writes all input parameters necessary to run a simulation, and runs the specified simulation by calling the correct functions with the specified parameters. So no need to use a journal or a script! But you still need to install following the procedure below.

To run the gui, import bifacialradiance and run bifacialradiance.gui()

GUI

Usage

We have a tutorial video, showing how the program is structured, how to use the Jupyter tutorials and the GUI. You can watch it here Tutorial Webinar, with the slides available here.

Check out the Jupyter Tutorial Notebooks to see detailed examples of the capacities of bifacial_radiance. The Intro examples and the readthedocs documentation also provide a good starting point.

Contributing

We need your help to make bifacialradiance a great tool! Please see the Contributing page for more on how you can contribute. The long-term success of bifacialradiance requires substantial community support.

License

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

Getting Support

If you suspect that you may have discovered a bug or if you'd like to change something about bifacial_radiance, then please make an issue on our GitHub issues page.

bifacial_radiance questions can be asked on Stack Overflow and tagged with the bifacial_radiance tag.

The bifacial-radiance google group has just started, and will be used for discussing various topics of interest to the bifacial-radiance community. We also make new version announcements on the google group.

Citing

If you use bifacial_radiance in a published work, please cite:

Ayala Pelaez and Deline, (2020). bifacial_radiance: a python package for modeling bifacial solar photovoltaic systems. Journal of Open Source Software, 5(50), 1865, https://doi.org/10.21105/joss.01865

Please also cite the DOI corresponding to the specific version of bifacialradiance that you used. bifacialradiance DOIs are listed at Zenodo.org

Additional bifacialradiance publications with validation of the software include: * Deline, Chris, and Ayala, Silvana. BifacialRadiance. Computer Software. https://github.com/NREL/bifacial_radiance. USDOE Office of Energy Efficiency and Renewable Energy (EERE), Solar Energy Technologies Office (EE-4S). 17 Dec. 2017. Web. doi:10.11578/dc.20180530.16. https://www.osti.gov/doecode/biblio/6869 * Ayala Pelaez S, Deline C, Greenberg P, Stein JS, Kostuk RK. Model and validation of single-axis tracking with bifacial PV. IEEE J Photovoltaics. 2019;9(3):715-721. https://ieeexplore.ieee.org/document/8644027 and https://www.nrel.gov/docs/fy19osti/72039.pdf (pre-print, conference version) * Ayala Pelaez, Deline C, MacAlpine M, Marion B, Stein J, Kostuk K. Comparison of Bifacial Solar Irradiance Model Predictions with Field Validation. IEEE J Photovoltaics. 2019; 9(1):82-87. https://ieeexplore.ieee.org/document/8534404

Or check our Github Wiki for a complete list of publications.

Owner

  • Name: National Renewable Energy Laboratory
  • Login: NREL
  • Kind: organization
  • Location: Golden, CO

JOSS Publication

bifacial_radiance: a python package for modeling bifacial solar photovoltaic systems
Published
June 12, 2020
Volume 5, Issue 50, Page 1865
Authors
Silvana Ayala Pelaez ORCID
National Renewable Energy Laboratory (NREL)
Chris Deline ORCID
National Renewable Energy Laboratory (NREL)
Editor
Melissa Weber Mendonça ORCID
Tags
solar energy photovoltaics renewable energy bifacial solar panels

GitHub Events

Total
  • Issues event: 9
  • Watch event: 8
  • Delete event: 2
  • Issue comment event: 11
  • Push event: 14
  • Pull request event: 4
  • Fork event: 9
  • Create event: 4
Last Year
  • Issues event: 9
  • Watch event: 8
  • Delete event: 2
  • Issue comment event: 11
  • Push event: 14
  • Pull request event: 4
  • Fork event: 9
  • Create event: 4

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 1,432
  • Total Committers: 16
  • Avg Commits per committer: 89.5
  • Development Distribution Score (DDS): 0.448
Past Year
  • Commits: 82
  • Committers: 3
  • Avg Commits per committer: 27.333
  • Development Distribution Score (DDS): 0.073
Top Committers
Name Email Commits
cdeline c****e@n****v 791
Silvana Ayala s****a@n****v 410
Ayala s****a@n****v 131
Arefeen s****n@n****v 32
Kevin Anderson k****n@n****v 21
Brown m****2@n****v 13
Jason Alderman a****n@g****m 9
Mark Mikofski b****o@y****m 8
Matt Prilliman M****n@n****v 3
dependabot[bot] 4****] 3
echedey-ls 8****s 3
mcbrown042 7****2 3
M B 8****t 2
Cameron Stark C****k 1
Kirsten Perry 7****l 1
Mandy Lewis a****0@u****a 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 382
  • Total pull requests: 185
  • Average time to close issues: 5 months
  • Average time to close pull requests: 16 days
  • Total issue authors: 93
  • Total pull request authors: 16
  • Average comments per issue: 2.13
  • Average comments per pull request: 1.39
  • Merged pull requests: 155
  • Bot issues: 0
  • Bot pull requests: 5
Past Year
  • Issues: 15
  • Pull requests: 19
  • Average time to close issues: 3 days
  • Average time to close pull requests: 19 days
  • Issue authors: 6
  • Pull request authors: 3
  • Average comments per issue: 0.87
  • Average comments per pull request: 0.79
  • Merged pull requests: 15
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • shirubana (142)
  • cdeline (75)
  • mikofski (7)
  • dalonsoa (7)
  • wholmgren (5)
  • Leo-Raumann (5)
  • dvalencia00 (5)
  • VENKATESHYARAMACHA (5)
  • ECSape (4)
  • olipfeifferthkoeln (4)
  • DS-Sagar (4)
  • StainesThomas (3)
  • mcbrown042 (3)
  • AgravatSM (3)
  • CameronTStark (3)
Pull Request Authors
  • cdeline (135)
  • shirubana (42)
  • kandersolar (7)
  • mjprilliman (6)
  • jalderman9 (5)
  • mikofski (5)
  • dependabot[bot] (5)
  • echedey-ls (2)
  • kperrynrel (2)
  • m-bartlett (2)
  • sofiatoropovaa (2)
  • CameronTStark (1)
  • amir-asgharzadeh (1)
  • jsstein (1)
  • mandylewis (1)
Top Labels
Issue Labels
Wishlists (32) bug (30) Fixed in development branch (29) v0_5_0 (27) enhancement (26) v0_3_5 (26) v0_3_4 (18) JOSS (9) v0_3_3 (8) v0_4_1 (6) HPC (6) gencumsky (5) linux (5) question (4) v0_6_0 (4) v_0_4_2 (4) geometry (2) error message improvement (2) dependencies (1) help wanted (1) Pvlib (1) documentation (1) wontfix (1) contribution (1) tutorial bug (1)
Pull Request Labels
Fixed in development branch (8) dependencies (5) v0_3_5 (2) tutorial bug (2)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 947 last-month
  • Total dependent packages: 1
  • Total dependent repositories: 1
  • Total versions: 15
  • Total maintainers: 1
pypi.org: bifacial-radiance

Tools to interface with Radiance for the PV researcher

  • Versions: 15
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 947 Last month
Rankings
Dependent packages count: 3.2%
Forks count: 6.1%
Stargazers count: 8.2%
Average: 10.6%
Downloads: 13.4%
Dependent repos count: 22.1%
Maintainers (1)
Last synced: 6 months ago

Dependencies

requirements.txt pypi
  • coverage ==6.3.1
  • cycler ==0.11.0
  • docutils <0.18
  • future *
  • idna ==3.3
  • importlib-metadata ==4.10.1
  • ipython ==7.31.1
  • kiwisolver ==1.3.2
  • matplotlib ==3.5.1
  • more-itertools ==8.12.0
  • numpy ==1.21.5
  • pandas ==1.3.5
  • pluggy ==1.0.0
  • pvlib ==0.9.0
  • pvmismatch ==4.1
  • py ==1.11.0
  • pyparsing ==3.0.7
  • pysmarts ==0.0.1
  • pytest ==7.0.0
  • pytest-cov ==3.0.0
  • python-dateutil ==2.8.2
  • pytz ==2021.3
  • requests *
  • six ==1.16.0
  • sphinx-autoapi ==1.8.4
  • sphinx-rtd-theme ==1.0.0
setup.py pypi
  • configparser *
  • pandas *
  • pvlib *
  • pvmismatch *
  • requests *
.github/workflows/deploy.yaml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • actions/upload-artifact v2 composite
.github/workflows/docker.yml actions
  • actions/checkout v2 composite
  • docker/build-push-action v2 composite
  • docker/login-action v1 composite
  • docker/setup-buildx-action v1 composite
.github/workflows/pytest.yaml actions
  • GabrielBB/xvfb-action v1 composite
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
docker/Dockerfile docker
  • python 3.7.8-buster build