bifacial-radiance


Namebifacial-radiance JSON
Version 0.4.2 PyPI version JSON
download
home_pagehttps://github.com/NREL/bifacial_radiance
SummaryTools to interface with Radiance for the PV researcher
upload_time2023-03-11 14:04:34
maintainer
docs_urlNone
authorChris Deline
requires_python
licenseBSD License (3 clause)
keywords bifacial radiance photovoltaics pv ray tracing
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ![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/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.



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/NREL/bifacial_radiance",
    "name": "bifacial-radiance",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "bifacial radiance photovoltaics pv ray tracing",
    "author": "Chris Deline",
    "author_email": "chris.deline@nrel.gov",
    "download_url": "https://files.pythonhosted.org/packages/77/b4/f23f82780c2a3441044c3ceca4ce1e037a14fa06a80ef62a5e4f2475961e/bifacial_radiance-0.4.2.tar.gz",
    "platform": null,
    "description": "![logo](docs/images_wiki/bifacial_radiance.png)\n\n# bifacial_radiance\nMain branch: [![Build Status](https://github.com/nrel/bifacial_radiance/actions/workflows/pytest.yaml/badge.svg?branch=main)](https://github.com/nrel/bifacial_radiance/actions)\n[![Coverage Status](https://coveralls.io/repos/github/NREL/bifacial_radiance/badge.svg?branch=main)](https://coveralls.io/github/NREL/bifacial_radiance?branch=main)\n[![Documentation Status](https://readthedocs.org/projects/bifacial-radiance/badge/?version=stable)](https://bifacial-radiance.readthedocs.io/en/latest/?badge=stable)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3860350.svg)](https://doi.org/10.5281/zenodo.3860350)\n[![status](https://joss.theoj.org/papers/b018890e2ab7ddf723d37b17e308e273/status.svg)](https://joss.theoj.org/papers/b018890e2ab7ddf723d37b17e308e273)\n\nDevelopment branch: [![Build Status](https://github.com/nrel/bifacial_radiance/actions/workflows/pytest.yaml/badge.svg?branch=development)](https://github.com/nrel/bifacial_radiance/actions)\n[![Coverage Status](https://coveralls.io/repos/github/NREL/bifacial_radiance/badge.svg?branch=development)](https://coveralls.io/github/NREL/bifacial_radiance?branch=development)\n[![Documentation Status](https://readthedocs.org/projects/bifacial-radiance/badge/?version=latest)](https://bifacial-radiance.readthedocs.io/en/latest/?badge=latest)\n\n## Introduction\n\nbifacial_radiance contains a series of Python wrapper functions to make working with \nRADIANCE easier, particularly for the PV researcher interested in bifacial PV \nperformance.  For more information, check out our [documentation](https://bifacial-radiance.readthedocs.io), \n[Tutorials in the form of Jupyter Notebooks](docs/tutorials/), or reffer to our [Wiki](https://github.com/NREL/bifacial_radiance/wiki)\nand [Issues](https://github.com/NREL/bifacial_radiance/issues) page. \n\n## Installation\n\nhttps://youtu.be/4A9GocfHKyM\nThis video shows how to install the bifacial_radiance software and all associated software needed. More info on the Wiki. Instructions are also shown below.\n\nFor detailed instructions of how to install bifacial_radiance, you can also refer to the [installation guide](https://bifacial-radiance.readthedocs.io/en/stable/installation.html)\n\n## GUI! \n\nA 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. \n\nTo run the gui, import bifacial_radiance and run bifacial_radiance.gui()\n\n![GUI](docs/images_wiki/bifacial_radiance_GUI.png)\n\n\n## Usage\n\nWe 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).\n\nCheck out the [Jupyter Tutorial Notebooks](docs/tutorials/) to see detailed examples of the capacities of bifacial_radiance.\nThe [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.\n\n## Contributing\n\nWe 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.\n\n## License\n\nBifacial_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).\n\n## Getting Support\n\nIf you suspect that you may have discovered a bug or if you'd like to\nchange something about bifacial_radiance, then please make an issue on our\n[GitHub issues page](https://github.com/NREL/bifacial_radiance/issues).\n\nbifacial_radiance questions can be asked on\n[Stack Overflow](http://stackoverflow.com) and tagged with\nthe [bifacial_radiance](http://stackoverflow.com/questions/tagged/bifacial_radiance) tag.\n\nThe [bifacial-radiance google group](https://groups.google.com/forum/#!forum/bifacial_radiance) \nhas just started, and will be used for discussing various topics of interest to the bifacial-radiance\ncommunity. We also make new version announcements on the google group.\n\n## Citing\n\nIf you use bifacial_radiance in a published work, please cite:\n\n    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\n\n\nPlease 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)\n\nAdditional bifacial_radiance publications with validation of the software include:\n* 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\n* 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)\n* 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\n\nOr check our [Github Wiki](https://github.com/NREL/bifacial_radiance/wiki) for a complete list of publications.\n\n\n",
    "bugtrack_url": null,
    "license": "BSD License (3 clause)",
    "summary": "Tools to interface with Radiance for the PV researcher",
    "version": "0.4.2",
    "project_urls": {
        "Homepage": "https://github.com/NREL/bifacial_radiance"
    },
    "split_keywords": [
        "bifacial",
        "radiance",
        "photovoltaics",
        "pv",
        "ray",
        "tracing"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9bd6918514971fdcdd6792e842e7b32ce91f0aa375bc9b48f726bf42e377e290",
                "md5": "1f2c6b936a669559b5cae4dff721f64d",
                "sha256": "f4a7e6fd1a6b787eae9aa6119ff0dbba05cc2f6ba45bb90ea4f5e6bd4f83ce4d"
            },
            "downloads": -1,
            "filename": "bifacial_radiance-0.4.2-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1f2c6b936a669559b5cae4dff721f64d",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 2010742,
            "upload_time": "2023-03-11T14:04:32",
            "upload_time_iso_8601": "2023-03-11T14:04:32.912637Z",
            "url": "https://files.pythonhosted.org/packages/9b/d6/918514971fdcdd6792e842e7b32ce91f0aa375bc9b48f726bf42e377e290/bifacial_radiance-0.4.2-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "77b4f23f82780c2a3441044c3ceca4ce1e037a14fa06a80ef62a5e4f2475961e",
                "md5": "8dde0adc5daa8bdff2a563bfb568e0d5",
                "sha256": "11a711d6dce5cf5ef5ce0d917166c1412eb5929a48b295317f0938daf5a576c9"
            },
            "downloads": -1,
            "filename": "bifacial_radiance-0.4.2.tar.gz",
            "has_sig": false,
            "md5_digest": "8dde0adc5daa8bdff2a563bfb568e0d5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 2018255,
            "upload_time": "2023-03-11T14:04:34",
            "upload_time_iso_8601": "2023-03-11T14:04:34.933407Z",
            "url": "https://files.pythonhosted.org/packages/77/b4/f23f82780c2a3441044c3ceca4ce1e037a14fa06a80ef62a5e4f2475961e/bifacial_radiance-0.4.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-11 14:04:34",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "NREL",
    "github_project": "bifacial_radiance",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "bifacial-radiance"
}
        
Elapsed time: 0.40932s