From e57359a57e971fc3394a50eb140fe40afb72f0dc Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Mon, 5 Dec 2022 13:35:55 -0500 Subject: [PATCH 1/3] bulk rename master -> main --- .github/PULL_REQUEST_TEMPLATE.md | 4 ++-- .github/workflows/asv_check.yml | 2 +- .github/workflows/publish.yml | 2 +- .github/workflows/pytest-remote-data.yml | 6 ++--- .github/workflows/pytest.yml | 2 +- README.md | 8 +++---- benchmarks/README.md | 6 ++--- docs/sphinx/source/conf.py | 2 +- docs/sphinx/source/contributing.rst | 22 +++++++++---------- docs/sphinx/source/index.rst | 8 +++---- docs/sphinx/source/user_guide/forecasts.rst | 4 ++-- .../sphinx/source/user_guide/installation.rst | 4 ++-- 12 files changed, 35 insertions(+), 35 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 15a3856159..9511a42f5e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -3,8 +3,8 @@ - [ ] Closes #xxxx - [ ] I am familiar with the [contributing guidelines](https://pvlib-python.readthedocs.io/en/latest/contributing.html) - [ ] Tests added - - [ ] Updates entries in [`docs/sphinx/source/reference`](https://github.com/pvlib/pvlib-python/blob/master/docs/sphinx/source/reference) for API changes. - - [ ] Adds description and name entries in the appropriate "what's new" file in [`docs/sphinx/source/whatsnew`](https://github.com/pvlib/pvlib-python/tree/master/docs/sphinx/source/whatsnew) for all changes. Includes link to the GitHub Issue with `` :issue:`num` `` or this Pull Request with `` :pull:`num` ``. Includes contributor name and/or GitHub username (link with `` :ghuser:`user` ``). + - [ ] Updates entries in [`docs/sphinx/source/reference`](https://github.com/pvlib/pvlib-python/blob/main/docs/sphinx/source/reference) for API changes. + - [ ] Adds description and name entries in the appropriate "what's new" file in [`docs/sphinx/source/whatsnew`](https://github.com/pvlib/pvlib-python/tree/main/docs/sphinx/source/whatsnew) for all changes. Includes link to the GitHub Issue with `` :issue:`num` `` or this Pull Request with `` :pull:`num` ``. Includes contributor name and/or GitHub username (link with `` :ghuser:`user` ``). - [ ] New code is fully documented. Includes [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) compliant docstrings, examples, and comments where necessary. - [ ] Pull request is nearly complete and ready for detailed review. - [ ] Maintainer: Appropriate GitHub Labels (including `remote-data`) and Milestone are assigned to the Pull Request and linked Issue. diff --git a/.github/workflows/asv_check.yml b/.github/workflows/asv_check.yml index 701f217ed9..0f6379eeb9 100644 --- a/.github/workflows/asv_check.yml +++ b/.github/workflows/asv_check.yml @@ -4,7 +4,7 @@ name: asv on: push: branches: - - master + - main pull_request: diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 0363316ee3..fb1f3366c9 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -4,7 +4,7 @@ on: pull_request: push: branches: - - master + - main tags: - "v*" diff --git a/.github/workflows/pytest-remote-data.yml b/.github/workflows/pytest-remote-data.yml index 347871658b..06adfb1807 100644 --- a/.github/workflows/pytest-remote-data.yml +++ b/.github/workflows/pytest-remote-data.yml @@ -1,5 +1,5 @@ # A secondary test job that only runs the iotools tests if explicitly requested -# (for pull requests) or on a push to the master branch. +# (for pull requests) or on a push to the main branch. # Because the iotools tests require GitHub secrets, we need to be careful about # malicious PRs accessing the secrets and exposing them externally. # @@ -48,7 +48,7 @@ on: types: [labeled] push: branches: - - master + - main jobs: test: @@ -68,7 +68,7 @@ jobs: steps: - uses: actions/checkout@v3 if: github.event_name == 'pull_request_target' - # pull_request_target runs in the context of the target branch (pvlib/master), + # pull_request_target runs in the context of the target branch (pvlib/main), # but what we need is the hypothetical merge commit from the PR: with: ref: "refs/pull/${{ github.event.number }}/merge" diff --git a/.github/workflows/pytest.yml b/.github/workflows/pytest.yml index 79e345baff..31d4c117c5 100644 --- a/.github/workflows/pytest.yml +++ b/.github/workflows/pytest.yml @@ -4,7 +4,7 @@ on: pull_request: push: branches: - - master + - main jobs: test: diff --git a/README.md b/README.md index 0186295f84..993cfa5665 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ License - + license @@ -28,11 +28,11 @@ documentation build status - - GitHub Actions Testing Status + + GitHub Actions Testing Status - codecov coverage + codecov coverage diff --git a/benchmarks/README.md b/benchmarks/README.md index b0e27c5214..93ed223157 100644 --- a/benchmarks/README.md +++ b/benchmarks/README.md @@ -7,7 +7,7 @@ tests are run using The basic structure of the tests and how to run them is described below. We refer readers to the ASV documentation for more details. The AstroPy -[documentation](https://github.com/astropy/astropy-benchmarks/tree/master) +[documentation](https://github.com/astropy/astropy-benchmarks/tree/main) may also be helpful. The test configuration is described in [asv.conf.json](asv.conf.json). @@ -23,7 +23,7 @@ For example, if your feature branch is named ``feature``, a useful asv run may be (from the same directory as `asv.conf.json`): ``` -$ asv run master..feature +$ asv run main..feature ``` This will generate timings for every commit between the two specified @@ -87,7 +87,7 @@ $ asv preview Nightly benchmarking -------------------- -The benchmarks are run nightly for new commits to pvlib-python/master. +The benchmarks are run nightly for new commits to pvlib-python/main. - Timing results: https://pvlib-benchmarker.github.io/pvlib-benchmarks/ - Information on the process: https://github.com/pvlib-benchmarker/pvlib-benchmarks diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index fb5228c332..cd2d6b379d 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -431,7 +431,7 @@ def make_github_url(file_name): "/docs/sphinx/source/api.rst" or "generated/pvlib.atmosphere.alt2pres.rst" """ - URL_BASE = "https://github.com/pvlib/pvlib-python/blob/master/" + URL_BASE = "https://github.com/pvlib/pvlib-python/blob/main/" # is it a gallery page? if any(d in file_name for d in sphinx_gallery_conf['gallery_dirs']): diff --git a/docs/sphinx/source/contributing.rst b/docs/sphinx/source/contributing.rst index 3e224f6abd..22df6a106a 100644 --- a/docs/sphinx/source/contributing.rst +++ b/docs/sphinx/source/contributing.rst @@ -102,8 +102,8 @@ A pull request can also quickly become unmanageable if it proposes changes to the API in order to implement another feature. Consider clearly and concisely documenting all proposed API changes before implementing any code. Modifying -`api.rst `_ -and/or the latest `whatsnew file `_ +`api.rst `_ +and/or the latest `whatsnew file `_ can help formalize this process. Questions about related issues frequently come up in the process of @@ -154,7 +154,7 @@ a timely manner is to: the issue with the appropriate milestone. #. Make a limited-scope pull request. It can be a lot of work to check all of the boxes in `pull request guidelines - `_, + `_, especially for pull requests with a lot of new primary code. See :ref:`pull-request-scope`. #. Tag pvlib community members or ``@pvlib`` when the pull @@ -217,7 +217,7 @@ We typically use GitHub's "`squash and merge `_" feature to merge your pull request into pvlib. GitHub will condense the commit history of your branch into a single commit when merging into -pvlib-python/master (the commit history on your branch remains +pvlib-python/main (the commit history on your branch remains unchanged). Therefore, you are free to make commits that are as big or small as you'd like while developing your pull request. @@ -230,7 +230,7 @@ Documentation Documentation must be written in `numpydoc format `_ format which is rendered using the `Sphinx Napoleon extension -`_. +`_. The numpydoc format includes a specification for the allowable input types. Python's `duck typing `_ @@ -258,7 +258,7 @@ Read the Docs build it for you. Building the docs locally requires installing pvlib python as an editable library (see :ref:`installation` for instructions). First, install the ``doc`` dependencies specified in the ``EXTRAS_REQUIRE`` section of -`setup.py `_. +`setup.py `_. An easy way to do this is with:: pip install pvlib[doc] @@ -288,7 +288,7 @@ Example Gallery The example gallery uses `sphinx-gallery `_ and is generated from script files in the -`docs/examples `_ +`docs/examples `_ directory. sphinx-gallery will execute example files that start with ``plot_`` and capture the output. @@ -325,7 +325,7 @@ Testing Developers **must** include comprehensive tests for any additions or modifications to pvlib. New unit test code should be placed in the corresponding test module in the -`pvlib/tests `_ +`pvlib/tests `_ directory. A pull request will automatically run the tests for you on a variety of @@ -334,7 +334,7 @@ typically more efficient to run and debug the tests in your own local environment. To run the tests locally, install the ``test`` dependencies specified in the -`setup.py `_ +`setup.py `_ file. See :ref:`installation` instructions for more information. pvlib's unit tests can easily be run by executing ``pytest`` on the @@ -492,7 +492,7 @@ tests are run using the `airspeed velocity performance tests for most contributions at this time. Pull request reviewers will provide further information if a performance test is necessary. See our `README -`_ +`_ for instructions on running the benchmarks. @@ -507,4 +507,4 @@ contributing.html>`_ for inspiration. Code of Conduct ~~~~~~~~~~~~~~~ All contributors are expected to adhere to the `Contributor Code of Conduct -`_. +`_. diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index ecb37d8225..bd41618841 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -19,7 +19,7 @@ Please see the :ref:`installation` page for installation help. For examples of how to use pvlib python, please see :ref:`package_overview` and our `Jupyter Notebook tutorials -`_. The documentation assumes general familiarity with Python, NumPy, and Pandas. Google searches will yield many excellent tutorials for these packages. @@ -72,9 +72,9 @@ Additional pvlib python publications include: * W.F. Holmgren, R.W. Andrews, A.T. Lorenzo, and J.S. Stein, “PVLIB Python 2015,” in 42nd Photovoltaic Specialists Conference, 2015. (`paper - `__ and + `__ and the `notebook to reproduce the figures - `_) + `_) * J.S. Stein, W.F. Holmgren, J. Forbess, and C.W. Hansen, "PVLIB: Open Source Photovoltaic Performance Modeling Functions for Matlab and Python," in 43rd Photovoltaic Specialists Conference, 2016. @@ -85,7 +85,7 @@ Additional pvlib python publications include: License ======= -`BSD 3-clause `_. +`BSD 3-clause `_. NumFOCUS ======== diff --git a/docs/sphinx/source/user_guide/forecasts.rst b/docs/sphinx/source/user_guide/forecasts.rst index d61b40387a..d549726fa3 100644 --- a/docs/sphinx/source/user_guide/forecasts.rst +++ b/docs/sphinx/source/user_guide/forecasts.rst @@ -46,9 +46,9 @@ We do not know of a similarly easy way to access archives of forecast data. This document demonstrates how to use pvlib python to create a PV power forecast using these tools. The `forecast `_ and `forecast_to_power +main/docs/tutorials/forecast.ipynb>`_ and `forecast_to_power `_ Jupyter notebooks +main/docs/tutorials/forecast_to_power.ipynb>`_ Jupyter notebooks provide additional example code. .. warning:: diff --git a/docs/sphinx/source/user_guide/installation.rst b/docs/sphinx/source/user_guide/installation.rst index 42d27faa6e..ec3ef3abff 100644 --- a/docs/sphinx/source/user_guide/installation.rst +++ b/docs/sphinx/source/user_guide/installation.rst @@ -98,7 +98,7 @@ repository `_ or go to the download the zip file of the most recent release. You can also use the nbviewer website to choose a tutorial to experiment with. Go to our `nbviewer tutorial page -`_. @@ -228,7 +228,7 @@ pvlib-python is compatible with Python 3. pvlib-python requires Pandas, Numpy, and SciPy. The minimum version requirements are specified in -`setup.py `_. +`setup.py `_. They are typically releases from several years ago. A handful of pvlib-python features require additional packages that must From e9a659bccf977dfa147ecfd01ac19b11f47e27ed Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Mon, 5 Dec 2022 13:44:47 -0500 Subject: [PATCH 2/3] a bit of cleanup --- docs/sphinx/source/contributing.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/source/contributing.rst b/docs/sphinx/source/contributing.rst index 22df6a106a..3742d0af40 100644 --- a/docs/sphinx/source/contributing.rst +++ b/docs/sphinx/source/contributing.rst @@ -102,7 +102,7 @@ A pull request can also quickly become unmanageable if it proposes changes to the API in order to implement another feature. Consider clearly and concisely documenting all proposed API changes before implementing any code. Modifying -`api.rst `_ +`api.rst `_ and/or the latest `whatsnew file `_ can help formalize this process. @@ -230,7 +230,7 @@ Documentation Documentation must be written in `numpydoc format `_ format which is rendered using the `Sphinx Napoleon extension -`_. +`_. The numpydoc format includes a specification for the allowable input types. Python's `duck typing `_ From 794971eedb3c0e19302c597ad3a483a09ae64887 Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Thu, 8 Dec 2022 11:06:38 -0500 Subject: [PATCH 3/3] also update the benchmarks config --- benchmarks/asv.conf.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/benchmarks/asv.conf.json b/benchmarks/asv.conf.json index afaf22daba..1ae618cb9f 100644 --- a/benchmarks/asv.conf.json +++ b/benchmarks/asv.conf.json @@ -29,7 +29,7 @@ // List of branches to benchmark. If not provided, defaults to "master" // (for git) or "default" (for mercurial). - // "branches": ["master"], // for git + "branches": ["main"], // for git // "branches": ["default"], // for mercurial // The DVCS being used. If not set, it will be automatically