pvdeg


Namepvdeg JSON
Version 0.3.0 PyPI version JSON
download
home_page
SummaryPvdeg is a python library that supports the calculation of degradation related parameters for photovoltaic (PV) modules.
upload_time2024-02-12 15:27:46
maintainer
docs_urlNone
author
requires_python<3.12,>=3.9.0
licenseBSD-3
keywords photovoltaic solar degradation analysis performance module pv
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <img src="pvdeg_tutorials/pvdeg_logo.png" width="200">

<table>
<tr>
  <td>License</td>
  <td>
    <a href="https://github.com/NREL/PVDegradationTools/blob/master/LICENSE.md">
    <img src="https://img.shields.io/pypi/l/pvlib.svg" alt="license" />
    </a>
</td>
</tr>
<tr>
  <td>Publications</td>
  <td>
     <a href="https://doi.org/10.5281/zenodo.8088578"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.8088578.svg" alt="DOI"></a>
  </td>
</tr>
<tr>
  <td>Documentation</td>
  <td>
	<a href='https://pvdegradationtools.readthedocs.io/en/latest/?badge=latest'>
	    <img src='https://readthedocs.org/projects/pvdegradationtools/badge/?version=latest' alt='Documentation Status' />
	</a>
  </td>
</tr>
<tr>
  <td>Build status</td>
  <td>
   <a href="https://github.com/NREL/PVDegradationTools/actions/workflows/pytest.yml?query=branch%3Amain">
      <img src="https://github.com/NREL/PVDegradationTools/actions/workflows/pytest.yml/badge.svg?branch=main" alt="GitHub Actions Testing Status" />
   </a>
   <a href="https://codecov.io/gh/NREL/PVDegradationTools" >
   <img src="https://codecov.io/gh/NREL/PVDegradationTools/graph/badge.svg?token=4I24S8BTG7"/>
   </a>
  </td>
</tr>
</table>



# PV Degradation Tools (pvdeg)

This repository contains functions for calculating degradation of photovoltaic modules. For example, functions to calculate front and rear relative Humidity, as well as Acceleration Factors. A degradation calculation function is also being developed, considering humidity and spectral irradiances models.


Tutorials
=========

### Jupyter Book

For in depth Tutorials you can run online, see our [jupyter-book](https://nrel.github.io/PVDegradationTools/intro.html) [![Jupyter Book Badge](https://jupyterbook.org/badge.svg)](https://nrel.github.io/PVDegradationTools/intro.html)

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.
Just uncomment the first line `pip install ...`  to install the environment on each journal if you follow this mode.

### Binder

To run these tutorials in Binder, you can click here:
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/NREL/PVDegradationTools/main)
It takes a minute to load the environment.

### Locally

You can also run the tutorial locally in a virtual environment, i.e., `venv` or
[miniconda](https://docs.conda.io/en/latest/miniconda.html).

1. Create and activate a new environment, e.g., on Mac/Linux terminal with `venv`:
   ```
   python -m venv pvdeg
   . pvdeg/bin/activate
   ```
   or with `conda`:
   ```
   conda create -n pvdeg
   conda activate pvdeg
   ```

1. Install `pvdeg` into the new environment with `pip`:
   ```
   python -m pip install pvdeg
   ```

1. Start a Jupyter session:

   ```
   jupyter notebook
   ```

1. Use the file explorer in Jupyter lab to browse to `tutorials`
   and start the first Tutorial.


Documentation
=============

Documentation is available in [ReadTheDocs](https://PVDegradationTools.readthedocs.io) where you can find more details on the API functions.


Installation
============

Relative Humidity and Acceleration Factors for Solar Modules releases may be installed using the ``pip`` and ``conda`` tools. Compatible with Python 3.5 and above.

Install with:

    pip install pvdeg

For developer installation, clone the repository, navigate to the folder location and install as:

    pip install -e .[all]


License
=======

[BSD 3-clause](https://github.com/NREL/PVDegradationTools/blob/main/LICENSE.md)


Contributing
=======

We welcome contributiosn to this software, but please read the copyright license agreement (cla-1.0.md), with instructions on signing it in sign-CLA.md. For questions, email us.


Getting support
===============

If you suspect that you may have discovered a bug or if you'd like to
change something about pvdeg, then please make an issue on our
[GitHub issues page](hhttps://github.com/NREL/PVDegradationTools/issues).


Citing
======

If you use this functions in a published work, please cite:

	Holsapple, Derek, Ayala Pelaez, Silvana, Kempe, Michael. "PV Degradation Tools", NREL Github 2020, Software Record SWR-20-71.

And/or the specific release from Zenodo:

	Ovaitt, Silvana, Brown, Matt, Springer, Martin, Karas, Joe, Holsapple, Derek, Kempe, Michael. (2023). NREL/PVDegradationTools: v0.1.0 official release (0.1.0). Zenodo. https://doi.org/10.5281/zenodo.8088403

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "pvdeg",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "<3.12,>=3.9.0",
    "maintainer_email": "Silvana.Ovaitt@nrel.gov",
    "keywords": "photovoltaic,solar,degradation,analysis,performance,module,PV",
    "author": "",
    "author_email": "Pvdeg Python Developers <Michael.Kempe@nrel.gov>",
    "download_url": "https://files.pythonhosted.org/packages/5c/6e/99deec61eec9049faea1b4ec3319ccba66184e305e114ee5a07562327f85/pvdeg-0.3.0.tar.gz",
    "platform": null,
    "description": "<img src=\"pvdeg_tutorials/pvdeg_logo.png\" width=\"200\">\n\n<table>\n<tr>\n  <td>License</td>\n  <td>\n    <a href=\"https://github.com/NREL/PVDegradationTools/blob/master/LICENSE.md\">\n    <img src=\"https://img.shields.io/pypi/l/pvlib.svg\" alt=\"license\" />\n    </a>\n</td>\n</tr>\n<tr>\n  <td>Publications</td>\n  <td>\n     <a href=\"https://doi.org/10.5281/zenodo.8088578\"><img src=\"https://zenodo.org/badge/DOI/10.5281/zenodo.8088578.svg\" alt=\"DOI\"></a>\n  </td>\n</tr>\n<tr>\n  <td>Documentation</td>\n  <td>\n\t<a href='https://pvdegradationtools.readthedocs.io/en/latest/?badge=latest'>\n\t    <img src='https://readthedocs.org/projects/pvdegradationtools/badge/?version=latest' alt='Documentation Status' />\n\t</a>\n  </td>\n</tr>\n<tr>\n  <td>Build status</td>\n  <td>\n   <a href=\"https://github.com/NREL/PVDegradationTools/actions/workflows/pytest.yml?query=branch%3Amain\">\n      <img src=\"https://github.com/NREL/PVDegradationTools/actions/workflows/pytest.yml/badge.svg?branch=main\" alt=\"GitHub Actions Testing Status\" />\n   </a>\n   <a href=\"https://codecov.io/gh/NREL/PVDegradationTools\" >\n   <img src=\"https://codecov.io/gh/NREL/PVDegradationTools/graph/badge.svg?token=4I24S8BTG7\"/>\n   </a>\n  </td>\n</tr>\n</table>\n\n\n\n# PV Degradation Tools (pvdeg)\n\nThis repository contains functions for calculating degradation of photovoltaic modules. For example, functions to calculate front and rear relative Humidity, as well as Acceleration Factors. A degradation calculation function is also being developed, considering humidity and spectral irradiances models.\n\n\nTutorials\n=========\n\n### Jupyter Book\n\nFor in depth Tutorials you can run online, see our [jupyter-book](https://nrel.github.io/PVDegradationTools/intro.html) [![Jupyter Book Badge](https://jupyterbook.org/badge.svg)](https://nrel.github.io/PVDegradationTools/intro.html)\n\nClicking on the rocket-icon on the top allows you to launch the journals on [Google Colaboratory](https://colab.research.google.com/) for interactive mode.\nJust uncomment the first line `pip install ...`  to install the environment on each journal if you follow this mode.\n\n### Binder\n\nTo run these tutorials in Binder, you can click here:\n[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/NREL/PVDegradationTools/main)\nIt takes a minute to load the environment.\n\n### Locally\n\nYou can also run the tutorial locally in a virtual environment, i.e., `venv` or\n[miniconda](https://docs.conda.io/en/latest/miniconda.html).\n\n1. Create and activate a new environment, e.g., on Mac/Linux terminal with `venv`:\n   ```\n   python -m venv pvdeg\n   . pvdeg/bin/activate\n   ```\n   or with `conda`:\n   ```\n   conda create -n pvdeg\n   conda activate pvdeg\n   ```\n\n1. Install `pvdeg` into the new environment with `pip`:\n   ```\n   python -m pip install pvdeg\n   ```\n\n1. Start a Jupyter session:\n\n   ```\n   jupyter notebook\n   ```\n\n1. Use the file explorer in Jupyter lab to browse to `tutorials`\n   and start the first Tutorial.\n\n\nDocumentation\n=============\n\nDocumentation is available in [ReadTheDocs](https://PVDegradationTools.readthedocs.io) where you can find more details on the API functions.\n\n\nInstallation\n============\n\nRelative Humidity and Acceleration Factors for Solar Modules releases may be installed using the ``pip`` and ``conda`` tools. Compatible with Python 3.5 and above.\n\nInstall with:\n\n    pip install pvdeg\n\nFor developer installation, clone the repository, navigate to the folder location and install as:\n\n    pip install -e .[all]\n\n\nLicense\n=======\n\n[BSD 3-clause](https://github.com/NREL/PVDegradationTools/blob/main/LICENSE.md)\n\n\nContributing\n=======\n\nWe welcome contributiosn to this software, but please read the copyright license agreement (cla-1.0.md), with instructions on signing it in sign-CLA.md. For questions, email us.\n\n\nGetting support\n===============\n\nIf you suspect that you may have discovered a bug or if you'd like to\nchange something about pvdeg, then please make an issue on our\n[GitHub issues page](hhttps://github.com/NREL/PVDegradationTools/issues).\n\n\nCiting\n======\n\nIf you use this functions in a published work, please cite:\n\n\tHolsapple, Derek, Ayala Pelaez, Silvana, Kempe, Michael. \"PV Degradation Tools\", NREL Github 2020, Software Record SWR-20-71.\n\nAnd/or the specific release from Zenodo:\n\n\tOvaitt, Silvana, Brown, Matt, Springer, Martin, Karas, Joe, Holsapple, Derek, Kempe, Michael. (2023). NREL/PVDegradationTools: v0.1.0 official release (0.1.0). Zenodo. https://doi.org/10.5281/zenodo.8088403\n",
    "bugtrack_url": null,
    "license": "BSD-3",
    "summary": "Pvdeg is a python library that supports the calculation of degradation related parameters for photovoltaic (PV) modules.",
    "version": "0.3.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/NREL/PVDegradationTools/issues",
        "Documentation": "https://pvdegradationtools.readthedocs.io/",
        "Homepage": "https://github.com/NREL/PVDegradationTools",
        "Source Code": "https://github.com/NREL/PVDegradationTools"
    },
    "split_keywords": [
        "photovoltaic",
        "solar",
        "degradation",
        "analysis",
        "performance",
        "module",
        "pv"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5e0a73bb25b3a0168c2a42ef39271c4b1d3c99b21c51d541e0286ba46371a958",
                "md5": "6b786a2e184d0d6ccc7db01f7e273306",
                "sha256": "0547d0b4a64539b5abd14bba616cc085a0dc8492619e23f5b5c93017e8f42edd"
            },
            "downloads": -1,
            "filename": "pvdeg-0.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6b786a2e184d0d6ccc7db01f7e273306",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.12,>=3.9.0",
            "size": 2672129,
            "upload_time": "2024-02-12T15:27:43",
            "upload_time_iso_8601": "2024-02-12T15:27:43.198109Z",
            "url": "https://files.pythonhosted.org/packages/5e/0a/73bb25b3a0168c2a42ef39271c4b1d3c99b21c51d541e0286ba46371a958/pvdeg-0.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5c6e99deec61eec9049faea1b4ec3319ccba66184e305e114ee5a07562327f85",
                "md5": "de2ecc5a63224bd9dccaa070ead1c84f",
                "sha256": "935f1595dab2b7c422f44748de3a4113caff598a95f2856a67aed9782dbcd6b6"
            },
            "downloads": -1,
            "filename": "pvdeg-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "de2ecc5a63224bd9dccaa070ead1c84f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.12,>=3.9.0",
            "size": 13670056,
            "upload_time": "2024-02-12T15:27:46",
            "upload_time_iso_8601": "2024-02-12T15:27:46.050301Z",
            "url": "https://files.pythonhosted.org/packages/5c/6e/99deec61eec9049faea1b4ec3319ccba66184e305e114ee5a07562327f85/pvdeg-0.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-12 15:27:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "NREL",
    "github_project": "PVDegradationTools",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pvdeg"
}
        
Elapsed time: 0.18215s