Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ authors:
orcid: "https://orcid.org/0000-0002-9867-8930"
title: "RdTools"
doi: 10.5281/zenodo.1210316
url: "https://github.com/NREL/rdtools"
url: "https://github.com/NatLabRockies/rdtools"
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at RdTools@nrel.gov. All
reported by contacting the project team at RdTools@nlr.gov. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<img src="./docs/sphinx/source/_images/logo_horizontal_highres.png" width="500" alt="RdTools logo"/>

Master branch:
[![Build Status](https://github.com/NREL/rdtools/workflows/pytest/badge.svg?branch=master)](https://github.com/NREL/rdtools/actions?query=branch%3Amaster)
[![Build Status](https://github.com/NatLabRockies/rdtools/workflows/pytest/badge.svg?branch=master)](https://github.com/NatLabRockies/rdtools/actions?query=branch%3Amaster)

Development branch:
[![Build Status](https://github.com/NREL/rdtools/workflows/pytest/badge.svg?branch=development)](https://github.com/NREL/rdtools/actions?query=branch%3Adevelopment)
[![Build Status](https://github.com/NatLabRockies/rdtools/workflows/pytest/badge.svg?branch=development)](https://github.com/NatLabRockies/rdtools/actions?query=branch%3Adevelopment)

Code coverage:
[![codecov](https://codecov.io/gh/NREL/rdtools/graph/badge.svg?token=K2HDjFkBws)](https://codecov.io/gh/NREL/rdtools)
[![codecov](https://codecov.io/gh/NatLabRockies/rdtools/graph/badge.svg?token=K2HDjFkBws)](https://codecov.io/gh/NatLabRockies/rdtools)

RdTools is an open-source library to support reproducible technical analysis of
time series data from photovoltaic energy systems. The library aims to provide
Expand Down Expand Up @@ -38,7 +38,7 @@ and the specific DOI coresponding to that version from [Zenodo](https://doi.org/
Martin Springer, Jiyang Yan, Kirsten Perry, Sandra Villamar, Will Vining,
Gregory Kimball, Daniel Ruth, Noah Moyer, Quyen Nguyen, Dirk Jordan,
Matthew Muller, and Chris Deline, RdTools, version {insert version}, Computer Software,
https://github.com/NREL/rdtools. DOI:{insert DOI}
https://github.com/NatLabRockies/rdtools. DOI:{insert DOI}

The underlying workflow of RdTools has been published in several places.
If you use RdTools in a published work, you may also wish to cite the following as
Expand Down Expand Up @@ -76,5 +76,5 @@ Other useful references which may also be consulted for degradation rate methodo

## Further Instructions and Updates

Check out the [wiki](https://github.com/NREL/rdtools/wiki) for additional usage documentation, and for information on development goals and framework.
Check out the [wiki](https://github.com/NatLabRockies/rdtools/wiki) for additional usage documentation, and for information on development goals and framework.

3 changes: 3 additions & 0 deletions docs/sphinx/source/changelog/pending.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,6 @@ Maintenance
``MANIFEST.in``, and ``rdtools/_version.py``. (:pull:`488`)
* Updated ``rdtools/__init__.py`` to use ``importlib.metadata`` for version
retrieval instead of versioneer. (:pull:`488`)
* Updated GitHub URLs and references from ``NREL/rdtools`` to
``NatLabRockies/rdtools`` and email addresses from ``@nrel.gov`` to
``@nlr.gov``. (:pull:`492`)
8 changes: 4 additions & 4 deletions docs/sphinx/source/changelog/v2.0.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ API Changes
right-labeled energy with :py:func:`~rdtools.normalization.energy_from_power`
before being used with these normalization functions (:pull:`105`, :pull:`108`).
* Remove ``low_power_cutoff`` parameter in :py:func:`~rdtools.filtering.clip_filter` (:issue:`84`).
* Many kwargs have changed name (but not input order) to bring nomenclature into
* Many kwargs have changed name (but not input order) to bring nomenclature into
closer alignment with the `DuraMAT pv-terms project <https://duramat.github.io/pv-terms>`_: (:pull:`185`)

* :py:func:`~rdtools.aggregation.aggregation_insol` first kwarg is now ``energy_normalized``.
* :py:func:`~rdtools.degradation.degradation_year_on_year`,
:py:func:`~rdtools.degradation.degradation_ols` and
* :py:func:`~rdtools.degradation.degradation_year_on_year`,
:py:func:`~rdtools.degradation.degradation_ols` and
:py:func:`~rdtools.degradation.degradation_classical_decomposition`
first kwarg is now ``energy_normalized``.
* :py:func:`~rdtools.filtering.normalized_filter` input kwargs are now ``energy_normalized``, ``energy_normalized_low`` and ``energy_normalized_high``.
Expand Down Expand Up @@ -97,7 +97,7 @@ Example Updates
variable names (:pull:`139`).
* Add soiling section to the original example notebook.
* Add a new example notebook that analyzes data from a PV system located at
NREL's South Table Mountain campus (PVDAQ system #4) (:pull:`171`).
NLR's South Table Mountain campus (PVDAQ system #4) (:pull:`171`).
* Explicitly register pandas datetime converters which were `deprecated <https://github.com/pandas-dev/pandas/issues/18301>`_.
* Add new ``system_availability_example.ipynb`` notebook (:pull:`131`)

Expand Down
6 changes: 3 additions & 3 deletions docs/sphinx/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@

# List of external link aliases. Allows use of :pull:`123` to autolink that PR
extlinks = {
"issue": ("https://github.com/NREL/rdtools/issues/%s", "GH #%s"),
"pull": ("https://github.com/NREL/rdtools/pull/%s", "GH #%s"),
"issue": ("https://github.com/NatLabRockies/rdtools/issues/%s", "GH #%s"),
"pull": ("https://github.com/NatLabRockies/rdtools/pull/%s", "GH #%s"),
"ghuser": ("https://github.com/%s", "@%s"),
}

Expand Down Expand Up @@ -195,7 +195,7 @@ def make_github_url(pagename):
# either a branch name or a git tag will work for the URL
branch = version_map.get(rtd_version, rtd_version)

URL_BASE = "https://github.com/nrel/rdtools/blob/{}/".format(branch)
URL_BASE = "https://github.com/NatLabRockies/rdtools/blob/{}/".format(branch)

# is it an API autogen page?
if pagename.startswith("generated/"):
Expand Down
22 changes: 11 additions & 11 deletions docs/sphinx/source/developer_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,16 @@ you'll need to clone the RdTools source repository from Github with e.g.

::

git clone https://github.com/NREL/rdtools.git
git clone https://github.com/NatLabRockies/rdtools.git

from the command line, or using a GUI git client like Github Desktop. This
will clone the entire git repository onto your computer.
will clone the entire git repository onto your computer.

Installing RdTools dependencies
-------------------------------

The packages necessary to run RdTools itself can be installed with ``pip``.
You can install the dependencies along with RdTools itself from
You can install the dependencies along with RdTools itself from
`PyPI <https://pypi.org/project/rdtools/>`_:

::
Expand Down Expand Up @@ -66,14 +66,14 @@ Installing optional dependencies

RdTools has extra dependencies for running its test suite and building its
documentation. These packages aren't necessary for running RdTools itself and
are only needed if you want to contribute source code to RdTools.
are only needed if you want to contribute source code to RdTools.

.. note::
These will install RdTools along with other packages necessary to build its
documentation and run its test suite. We recommend doing this in a virtual
environment to keep package installations between projects separate!

Optional dependencies can be installed with the special
Optional dependencies can be installed with the special
`syntax <https://setuptools.readthedocs.io/en/latest/setuptools.html#declaring-extras-optional-features-with-their-own-dependencies>`_:

::
Expand Down Expand Up @@ -115,7 +115,7 @@ And even a single test function:

pytest rdtools/test/soiling_test.py::test_soiling_srr

You can also evaluate code coverage when running the test suite using the
You can also evaluate code coverage when running the test suite using the
`coverage <https://coverage.readthedocs.io>`_ package:

::
Expand All @@ -129,7 +129,7 @@ summary report showing how much much of each source file was
executed in the test suite. If a percentage is below 100, that means a
function isn't tested or a branch inside a function isn't tested. To get
specific details, you can run ``coverage html`` to generate a detailed HTML
report at ``htmlcov/index.html`` to view in a browser.
report at ``htmlcov/index.html`` to view in a browser.


Running the notebooks as tests
Expand Down Expand Up @@ -214,7 +214,7 @@ docs should result in output like this:
dumping search index in English (code: en) ... done
dumping object inventory... done
build succeeded.

The HTML pages are in build\html.

If you get an error like ``Pandoc wasn't found``, you can install it with conda:
Expand All @@ -230,15 +230,15 @@ Contributing
------------

Community participation is welcome! New contributions should be based on the
``development`` branch as the ``master`` branch is used only for releases.
``development`` branch as the ``master`` branch is used only for releases.

RdTools follows the `PEP 8 <https://www.python.org/dev/peps/pep-0008/>`_ style guide.
We recommend setting up your text editor to automatically highlight style
violations because it's easy to miss some issues (trailing whitespace, etc) otherwise.

Additionally, our documentation is built in part from docstrings in the source
code. These docstrings must be in `NumpyDoc format <https://numpydoc.readthedocs.io/en/latest/format.html>`_
to be rendered correctly in the documentation.
to be rendered correctly in the documentation.

Finally, all code should be tested. Some older tests in RdTools use the unittest
module, but new tests should all use pytest.
module, but new tests should all use pytest.
16 changes: 8 additions & 8 deletions docs/sphinx/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The preferred method for degradation rate estimation is the year-on-year
(YOY) approach (Jordan 2018), available in :py:func:`.degradation.degradation_year_on_year`.
The YOY calculation yields a distribution of degradation rates, the
central tendency of which is the most representative of the true
degradation. We note that the workflow described above and implemented in
degradation. We note that the workflow described above and implemented in
:py:class:`.analysis_chains.TrendAnalysis` provides an estimate of degradation rate,
not performance loss rate (PLR). PLR includes losses that are explicitly filtered
out by the primary workflow (Deceglie 2023).
Expand Down Expand Up @@ -102,14 +102,14 @@ The combined estimation of degradation and soiling (CODS) method (Skomedal 2020)
in RdTools. CODS self-consistently extracts degradation, soiling, and seasonality
of the daily-aggregated normalized performance signal. It is particularly useful
when soiling trends are biasing degradation results. It's use is shown in both the TrendAnalysis
example notebook as well as the funtional API example notebook for degradation and soiling.
example notebook as well as the funtional API example notebook for degradation and soiling.

TrendAnalysis
^^^^^^^^^^^^^
An object-oriented API for complete soiling and degradation analysis including
An object-oriented API for complete soiling and degradation analysis including
the normalize, filter, aggregate, analyze steps is available in
:py:class:`.analysis_chains.TrendAnalysis`. See the
`TrendAnalysis example <examples/TrendAnalysis_example_pvdaq4.html>`_ for details.
`TrendAnalysis example <examples/TrendAnalysis_example_pvdaq4.html>`_ for details.

Availability
------------
Expand Down Expand Up @@ -187,7 +187,7 @@ and the specific DOI coresponding to that version from `Zenodo <https://doi.org/
Martin Springer, Jiyang Yan, Kirsten Perry, Sandra Villamar, Will Vining,
Gregory Kimball, Daniel Ruth, Noah Moyer, Quyen Nguyen, Dirk Jordan,
Matthew Muller, and Chris Deline, RdTools, version {insert version},
Compuer Software, https://github.com/NREL/rdtools. DOI:{insert DOI}
Compuer Software, https://github.com/NatLabRockies/rdtools. DOI:{insert DOI}

The underlying workflow of RdTools has been published in several places.
If you use RdTools in a published work, you may also wish to cite the following as
Expand Down Expand Up @@ -220,7 +220,7 @@ References
:py:func:`.clearsky_temperature.get_clearsky_tamb()`, uses data from images
created by Jesse Allen, NASA’s Earth Observatory using data courtesy
of the MODIS Land Group.

+ https://neo.sci.gsfc.nasa.gov/view.php?datasetId=MOD_LSTD_CLIM_M
+ https://neo.sci.gsfc.nasa.gov/view.php?datasetId=MOD_LSTN_CLIM_M

Expand Down Expand Up @@ -275,5 +275,5 @@ Indices and tables


.. links and references
.. _release: https://github.com/NREL/rdtools/releases
.. _github: https://github.com/NREL/rdtools
.. _release: https://github.com/NatLabRockies/rdtools/releases
.. _github: https://github.com/NatLabRockies/rdtools
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -85,10 +85,10 @@ all = [
]

[project.urls]
Homepage = "https://github.com/NREL/rdtools"
"Bug Tracker" = "https://github.com/NREL/rdtools/issues"
Homepage = "https://github.com/NatLabRockies/rdtools"
"Bug Tracker" = "https://github.com/NatLabRockies/rdtools/issues"
Documentation = "https://rdtools.readthedocs.io/"
"Source Code" = "https://github.com/NREL/rdtools"
"Source Code" = "https://github.com/NatLabRockies/rdtools"

[tool.setuptools_scm]

Expand Down
4 changes: 2 additions & 2 deletions rdtools/soiling.py
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ def _calc_daily_df(self, day_scale=13, clean_threshold='infer',
warnings.warn('An even value of day_scale was passed. An odd value is '
'recommended, otherwise, consecutive days may be erroneously '
'flagged as cleaning events. '
'See https://github.com/NREL/rdtools/issues/189',
'See https://github.com/NatLabRockies/rdtools/issues/189',
stacklevel=2)

df = self.pm.to_frame()
Expand Down Expand Up @@ -383,7 +383,7 @@ def _calc_monte(self, monte, method='half_norm_clean'):
'validity criteria such as increasing "max_relative_slope_error" '
'and/or "max_negative_step" and/or decreasing "min_interval_length".'
' Alternatively, consider using method="perfect_clean". For more'
' info see https://github.com/NREL/rdtools/issues/272',
' info see https://github.com/NatLabRockies/rdtools/issues/272',
stacklevel=2
)
monte_losses = []
Expand Down
2 changes: 1 addition & 1 deletion rdtools/test/filtering_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -509,7 +509,7 @@ def test_hour_angle_filter():
series = pd.Series([1, 2, 3, 4, 5], index=index)

# Define latitude and longitude
lat, lon = 39.7413, -105.1684 # NREL, Golden, CO
lat, lon = 39.7413, -105.1684 # NLR, Golden, CO

# Call the function with the test data
result = hour_angle_filter(series, lat, lon)
Expand Down
2 changes: 1 addition & 1 deletion rdtools/test/soiling_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ def test_soiling_srr_max_negative_slope_error(soiling_normalized_daily, soiling_
def test_soiling_srr_with_nan_interval(soiling_normalized_daily, soiling_insolation):
'''
Previous versions had a bug which would have raised an error when an entire interval
was NaN. See https://github.com/NREL/rdtools/issues/129
was NaN. See https://github.com/NatLabRockies/rdtools/issues/129
'''
reps = 10
normalized_corrupt = soiling_normalized_daily.copy()
Expand Down