-
Notifications
You must be signed in to change notification settings - Fork 48
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
v0.4.4 add the rest of the files in the filestructure.
- Loading branch information
Showing
83 changed files
with
75,054 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
![logo](docs/images_wiki/bifacial_radiance.png) | ||
|
||
# bifacial_radiance | ||
Main branch: [![Build Status](https://github.com/nrel/bifacial_radiance/actions/workflows/pytest.yaml/badge.svg?branch=main)](https://github.com/nrel/bifacial_radiance/actions) | ||
[![Coverage Status](https://coveralls.io/repos/github/NREL/bifacial_radiance/badge.svg?branch=main)](https://coveralls.io/github/NREL/bifacial_radiance?branch=main) | ||
[![Documentation Status](https://readthedocs.org/projects/bifacial-radiance/badge/?version=stable)](https://bifacial-radiance.readthedocs.io/en/latest/?badge=stable) | ||
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3860350.svg)](https://doi.org/10.5281/zenodo.3860350) | ||
[![status](https://joss.theoj.org/papers/b018890e2ab7ddf723d37b17e308e273/status.svg)](https://joss.theoj.org/papers/b018890e2ab7ddf723d37b17e308e273) | ||
|
||
Development branch: [![Build Status](https://github.com/nrel/bifacial_radiance/actions/workflows/pytest.yaml/badge.svg?branch=development)](https://github.com/nrel/bifacial_radiance/actions) | ||
[![Coverage Status](https://coveralls.io/repos/github/NREL/bifacial_radiance/badge.svg?branch=development)](https://coveralls.io/github/NREL/bifacial_radiance?branch=development) | ||
[![Documentation Status](https://readthedocs.org/projects/bifacial-radiance/badge/?version=latest)](https://bifacial-radiance.readthedocs.io/en/latest/?badge=latest) | ||
|
||
## 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](https://bifacial-radiance.readthedocs.io), | ||
[Tutorials in the form of Jupyter Notebooks](docs/tutorials/), or reffer to our [Wiki](https://github.com/NREL/bifacial_radiance/wiki) | ||
and [Issues](https://github.com/NREL/bifacial_radiance/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](https://bifacial-radiance.readthedocs.io/en/stable/user_guide/installation.html) | ||
|
||
## 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 bifacial_radiance and run bifacial_radiance.gui() | ||
|
||
![GUI](docs/images_wiki/bifacial_radiance_GUI.png) | ||
|
||
|
||
## 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](https://www.youtube.com/watch?v=1X9L-R-RVGA), with the [slides available here](https://www.nrel.gov/docs/fy20osti/75218.pdf). | ||
|
||
Check out the [Jupyter Tutorial Notebooks](docs/tutorials/) to see detailed examples of the capacities of bifacial_radiance. | ||
The [Intro examples](https://bifacial-radiance.readthedocs.io/en/stable/introexamples.html) and the [readthedocs documentation](https://bifacial-radiance.readthedocs.io) also provide a good starting point. | ||
|
||
## Contributing | ||
|
||
We need your help to make bifacial_radiance a great tool! Please see the [Contributing page](https://bifacial-radiance.readthedocs.io/en/stable/contributing.html) for more on how you can contribute. The long-term success of bifacial_radiance 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](https://github.com/NREL/bifacial_radiance/blob/master/LICENSE). | ||
|
||
## 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](https://github.com/NREL/bifacial_radiance/issues). | ||
|
||
bifacial_radiance questions can be asked on | ||
[Stack Overflow](http://stackoverflow.com) and tagged with | ||
the [bifacial_radiance](http://stackoverflow.com/questions/tagged/bifacial_radiance) tag. | ||
|
||
The [bifacial-radiance google group](https://groups.google.com/forum/#!forum/bifacial_radiance) | ||
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 bifacial_radiance that you used. bifacial_radiance DOIs are listed at [Zenodo.org](https://zenodo.org/search?page=1&size=20&q=conceptrecid:3860349&all_versions&sort=-version) | ||
|
||
Additional bifacial_radiance publications with validation of the software include: | ||
* Deline, Chris, and Ayala, Silvana. Bifacial_Radiance. 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](https://github.com/NREL/bifacial_radiance/wiki) for a complete list of publications. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Welcome to the interactive bifacial_radiance Training | ||
|
||
Here is a collection of Jupyter Journals ready to run in your browser | ||
through Google Collab and expore the capabilities of bifacial_radiance. | ||
|
||
Clicking on the rocket-icon on the top allows you to launch the journals on | ||
[Google Colaboratory](https://colab.research.google.com/) for interactive mode. | ||
As per the instructions on each journal, you should uncomment the first line | ||
that reads `pip install ...` to install the environment if you follow this mode. | ||
|
||
You can also clone the repository and run them locally, following the | ||
instructions on the [PV_ICE Github page](https://github.com/NREL/bifacial_radiance) | ||
|
||
```{tableofcontents} | ||
``` |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
/* CSS for binder integration */ | ||
|
||
div.binder-badge { | ||
margin: 1em auto; | ||
vertical-align: middle; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
/* Pandas dataframe css */ | ||
/* Taken from: https://github.com/spatialaudio/nbsphinx/blob/fb3ba670fc1ba5f54d4c487573dbc1b4ecf7e9ff/src/nbsphinx.py#L587-L619 */ | ||
|
||
table.dataframe { | ||
border: none !important; | ||
border-collapse: collapse; | ||
border-spacing: 0; | ||
border-color: transparent; | ||
color: black; | ||
font-size: 12px; | ||
table-layout: fixed; | ||
} | ||
table.dataframe thead { | ||
border-bottom: 1px solid black; | ||
vertical-align: bottom; | ||
} | ||
table.dataframe tr, | ||
table.dataframe th, | ||
table.dataframe td { | ||
text-align: right; | ||
vertical-align: middle; | ||
padding: 0.5em 0.5em; | ||
line-height: normal; | ||
white-space: normal; | ||
max-width: none; | ||
border: none; | ||
} | ||
table.dataframe th { | ||
font-weight: bold; | ||
} | ||
table.dataframe tbody tr:nth-child(odd) { | ||
background: #f5f5f5; | ||
} | ||
table.dataframe tbody tr:hover { | ||
background: rgba(66, 165, 245, 0.2); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,204 @@ | ||
/* | ||
Sphinx-Gallery has compatible CSS to fix default sphinx themes | ||
Tested for Sphinx 1.3.1 for all themes: default, alabaster, sphinxdoc, | ||
scrolls, agogo, traditional, nature, haiku, pyramid | ||
Tested for Read the Docs theme 0.1.7 */ | ||
.sphx-glr-thumbcontainer { | ||
background: #fff; | ||
border: solid #fff 1px; | ||
-moz-border-radius: 5px; | ||
-webkit-border-radius: 5px; | ||
border-radius: 5px; | ||
box-shadow: none; | ||
float: left; | ||
margin: 5px; | ||
min-height: 230px; | ||
padding-top: 5px; | ||
position: relative; | ||
} | ||
.sphx-glr-thumbcontainer:hover { | ||
border: solid #b4ddfc 1px; | ||
box-shadow: 0 0 15px rgba(142, 176, 202, 0.5); | ||
} | ||
.sphx-glr-thumbcontainer a.internal { | ||
bottom: 0; | ||
display: block; | ||
left: 0; | ||
padding: 150px 10px 0; | ||
position: absolute; | ||
right: 0; | ||
top: 0; | ||
} | ||
/* Next one is to avoid Sphinx traditional theme to cover all the | ||
thumbnail with its default link Background color */ | ||
.sphx-glr-thumbcontainer a.internal:hover { | ||
background-color: transparent; | ||
} | ||
|
||
.sphx-glr-thumbcontainer p { | ||
margin: 0 0 .1em 0; | ||
} | ||
.sphx-glr-thumbcontainer .figure { | ||
margin: 10px; | ||
width: 160px; | ||
} | ||
.sphx-glr-thumbcontainer img { | ||
display: inline; | ||
max-height: 112px; | ||
max-width: 160px; | ||
} | ||
.sphx-glr-thumbcontainer[tooltip]:hover:after { | ||
background: rgba(0, 0, 0, 0.8); | ||
-webkit-border-radius: 5px; | ||
-moz-border-radius: 5px; | ||
border-radius: 5px; | ||
color: #fff; | ||
content: attr(tooltip); | ||
left: 95%; | ||
padding: 5px 15px; | ||
position: absolute; | ||
z-index: 98; | ||
width: 220px; | ||
bottom: 52%; | ||
} | ||
.sphx-glr-thumbcontainer[tooltip]:hover:before { | ||
border: solid; | ||
border-color: #333 transparent; | ||
border-width: 18px 0 0 20px; | ||
bottom: 58%; | ||
content: ''; | ||
left: 85%; | ||
position: absolute; | ||
z-index: 99; | ||
} | ||
|
||
.sphx-glr-script-out { | ||
color: #888; | ||
margin: 0; | ||
} | ||
p.sphx-glr-script-out { | ||
padding-top: 0.7em; | ||
} | ||
.sphx-glr-script-out .highlight { | ||
background-color: transparent; | ||
margin-left: 2.5em; | ||
margin-top: -2.1em; | ||
} | ||
.sphx-glr-script-out .highlight pre { | ||
background-color: #fafae2; | ||
border: 0; | ||
max-height: 30em; | ||
overflow: auto; | ||
padding-left: 1ex; | ||
margin: 0px; | ||
word-break: break-word; | ||
} | ||
.sphx-glr-script-out + p { | ||
margin-top: 1.8em; | ||
} | ||
blockquote.sphx-glr-script-out { | ||
margin-left: 0pt; | ||
} | ||
.sphx-glr-script-out.highlight-pytb .highlight pre { | ||
color: #000; | ||
background-color: #ffe4e4; | ||
border: 1px solid #f66; | ||
margin-top: 10px; | ||
padding: 7px; | ||
} | ||
|
||
div.sphx-glr-footer { | ||
text-align: center; | ||
} | ||
|
||
div.sphx-glr-download { | ||
margin: 1em auto; | ||
vertical-align: middle; | ||
} | ||
|
||
div.sphx-glr-download a { | ||
background-color: #ffc; | ||
background-image: linear-gradient(to bottom, #FFC, #d5d57e); | ||
border-radius: 4px; | ||
border: 1px solid #c2c22d; | ||
color: #000; | ||
display: inline-block; | ||
font-weight: bold; | ||
padding: 1ex; | ||
text-align: center; | ||
} | ||
|
||
div.sphx-glr-download code.download { | ||
display: inline-block; | ||
white-space: normal; | ||
word-break: normal; | ||
overflow-wrap: break-word; | ||
/* border and background are given by the enclosing 'a' */ | ||
border: none; | ||
background: none; | ||
} | ||
|
||
div.sphx-glr-download a:hover { | ||
box-shadow: inset 0 1px 0 rgba(255,255,255,.1), 0 1px 5px rgba(0,0,0,.25); | ||
text-decoration: none; | ||
background-image: none; | ||
background-color: #d5d57e; | ||
} | ||
|
||
.sphx-glr-example-title > :target::before { | ||
display: block; | ||
content: ""; | ||
margin-top: -50px; | ||
height: 50px; | ||
visibility: hidden; | ||
} | ||
|
||
ul.sphx-glr-horizontal { | ||
list-style: none; | ||
padding: 0; | ||
} | ||
ul.sphx-glr-horizontal li { | ||
display: inline; | ||
} | ||
ul.sphx-glr-horizontal img { | ||
height: auto !important; | ||
} | ||
|
||
.sphx-glr-single-img { | ||
margin: auto; | ||
display: block; | ||
max-width: 100%; | ||
} | ||
|
||
.sphx-glr-multi-img { | ||
max-width: 42%; | ||
height: auto; | ||
} | ||
|
||
div.sphx-glr-animation { | ||
margin: auto; | ||
display: block; | ||
max-width: 100%; | ||
} | ||
div.sphx-glr-animation .animation{ | ||
display: block; | ||
} | ||
|
||
p.sphx-glr-signature a.reference.external { | ||
-moz-border-radius: 5px; | ||
-webkit-border-radius: 5px; | ||
border-radius: 5px; | ||
padding: 3px; | ||
font-size: 75%; | ||
text-align: right; | ||
margin-left: auto; | ||
display: table; | ||
} | ||
|
||
.sphx-glr-clear{ | ||
clear: both; | ||
} | ||
|
||
a.sphx-glr-backref-instance { | ||
text-decoration: none; | ||
} |
Oops, something went wrong.