diff --git a/CITATION.cff b/CITATION.cff index 2c050d4b..299bd599 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -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" \ No newline at end of file +url: "https://github.com/NatLabRockies/rdtools" \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index c18f3d79..e7799a42 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -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. diff --git a/README.md b/README.md index 189a4f61..39050dce 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ 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 @@ -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 @@ -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. diff --git a/docs/sphinx/source/changelog/pending.rst b/docs/sphinx/source/changelog/pending.rst index 2fdb3be2..29f438ae 100644 --- a/docs/sphinx/source/changelog/pending.rst +++ b/docs/sphinx/source/changelog/pending.rst @@ -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`) diff --git a/docs/sphinx/source/changelog/v2.0.0.rst b/docs/sphinx/source/changelog/v2.0.0.rst index a9b98145..e383f575 100644 --- a/docs/sphinx/source/changelog/v2.0.0.rst +++ b/docs/sphinx/source/changelog/v2.0.0.rst @@ -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 `_: (: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``. @@ -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 `_. * Add new ``system_availability_example.ipynb`` notebook (:pull:`131`) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index c46717ae..4bfd1da3 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -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"), } @@ -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/"): diff --git a/docs/sphinx/source/developer_notes.rst b/docs/sphinx/source/developer_notes.rst index d33272f2..c4b50250 100644 --- a/docs/sphinx/source/developer_notes.rst +++ b/docs/sphinx/source/developer_notes.rst @@ -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 `_: :: @@ -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 `_: :: @@ -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 `_ package: :: @@ -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 @@ -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: @@ -230,7 +230,7 @@ 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 `_ style guide. We recommend setting up your text editor to automatically highlight style @@ -238,7 +238,7 @@ violations because it's easy to miss some issues (trailing whitespace, etc) othe Additionally, our documentation is built in part from docstrings in the source code. These docstrings must be in `NumpyDoc format `_ -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. \ No newline at end of file +module, but new tests should all use pytest. \ No newline at end of file diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index cf6d0f0c..4349fb5f 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -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). @@ -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 `_ for details. +`TrendAnalysis example `_ for details. Availability ------------ @@ -187,7 +187,7 @@ and the specific DOI coresponding to that version from `Zenodo