Ouranosinc · Zeitsperre · Feb 27, 2024 · Feb 26, 2024 · Feb 26, 2024 · Feb 26, 2024
diff --git a/.github/DISCUSSION_TEMPLATE/questions.yml b/.github/DISCUSSION_TEMPLATE/questions.yml
@@ -6,7 +6,7 @@ body:
  attributes:
  value: |
  Thanks for opening this discussion!
- Before you submit, please make sure you have read our [Code of Conduct](https://github.com/Ouranosinc/xclim/blob/master/CODE_OF_CONDUCT.md).
+ Before you submit, please make sure you have read our [Code of Conduct](https://github.com/Ouranosinc/xclim/blob/main/CODE_OF_CONDUCT.md).
  - type: textarea
  id: setup-information
  attributes:

diff --git a/.github/DISCUSSION_TEMPLATE/translations.yml b/.github/DISCUSSION_TEMPLATE/translations.yml
@@ -6,7 +6,7 @@ body:
  attributes:
  value: |
  Thanks for taking the time to help translate Xclim's documentation!
- Before you submit, please make sure you have read our [Code of Conduct](https://github.com/Ouranosinc/xclim/blob/master/CODE_OF_CONDUCT.md).
+ Before you submit, please make sure you have read our [Code of Conduct](https://github.com/Ouranosinc/xclim/blob/main/CODE_OF_CONDUCT.md).
  - type: textarea
  id: language
  attributes:

diff --git a/.github/ISSUE_TEMPLATE/0001-GENERIC-ISSUE-TEMPLATE.yml b/.github/ISSUE_TEMPLATE/0001-GENERIC-ISSUE-TEMPLATE.yml
@@ -36,7 +36,7 @@ body:
  id: terms
  attributes:
  label: Code of Conduct
- description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Ouranosinc/xclim/blob/master/CODE_OF_CONDUCT.md)
+ description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Ouranosinc/xclim/blob/main/CODE_OF_CONDUCT.md)
  options:
  - label: I agree to follow this project's Code of Conduct
  required: true
diff --git a/.github/ISSUE_TEMPLATE/0002-BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/0002-BUG-REPORT.yml
@@ -46,7 +46,7 @@ body:
  id: terms
  attributes:
  label: Code of Conduct
- description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Ouranosinc/xclim/blob/master/CODE_OF_CONDUCT.md)
+ description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Ouranosinc/xclim/blob/main/CODE_OF_CONDUCT.md)
  options:
  - label: I agree to follow this project's Code of Conduct
  required: true
diff --git a/.github/ISSUE_TEMPLATE/0003-FEATURE-REQUEST.yml b/.github/ISSUE_TEMPLATE/0003-FEATURE-REQUEST.yml
@@ -33,7 +33,7 @@ body:
  id: terms
  attributes:
  label: Code of Conduct
- description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Ouranosinc/xclim/blob/master/CODE_OF_CONDUCT.md)
+ description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Ouranosinc/xclim/blob/main/CODE_OF_CONDUCT.md)
  options:
  - label: I agree to follow this project's Code of Conduct
  required: true
diff --git a/.github/workflows/bump-version.yml b/.github/workflows/bump-version.yml
@@ -3,7 +3,7 @@ name: Bump Patch Version
 on:
  push:
  branches:
- - master
+ - main
  paths-ignore:
  - .*
  - .github/*/*.md

diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -3,7 +3,7 @@ name: CodeQL Scan
 on:
  push:
  branches:
- - master
+ - main
  paths-ignore:
  - CHANGES.rst
  - Makefile

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -3,7 +3,7 @@ name: xclim Testing Suite
 on:
  push:
  branches:
- - master
+ - main
  paths-ignore:
  - CHANGES.rst
  - README.rst
@@ -22,9 +22,9 @@ env:
  XCLIM_TESTDATA_BRANCH: v2023.12.14
 
 concurrency:
- # For a given workflow, if we push to the same branch, cancel all previous builds on that branch except on master.
+ # For a given workflow, if we push to the same branch, cancel all previous builds on that branch except on main.
  group: ${{ github.workflow }}-${{ github.ref }}
- cancel-in-progress: ${{ github.ref != 'refs/heads/master' }}
+ cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
 
 permissions:
  contents: read

diff --git a/.github/workflows/scorecard.yml b/.github/workflows/scorecard.yml
@@ -13,7 +13,7 @@ on:
  - cron: '41 8 * * 4'
  push:
  branches:
- - master
+ - main
 
 # Declare default permissions as read only.
 permissions: read-all

diff --git a/.github/workflows/upstream.yml b/.github/workflows/upstream.yml
@@ -2,7 +2,7 @@ name: Test Upstream Dependencies
 on:
  push:
  branches:
- - master
+ - main
  paths-ignore:
  - CHANGES.rst
  - README.rst

diff --git a/CHANGES.rst b/CHANGES.rst
@@ -2,6 +2,14 @@
 Changelog
 =========
 
+v0.49.0 (unreleased)
+--------------------
+Contributors to this version: Trevor James Smith (:user:`Zeitsperre`).
+
+Announcements
+^^^^^^^^^^^^^
+* `xclim` has migrated its development branch name from `master` to `main`. (:issue:`1667`, :pull:`1669`).
+
 v0.48.2 (2024-02-26)
 --------------------
 Contributors to this version: Juliette Lavoie (:user:`juliettelavoie`).

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -261,7 +261,7 @@ Before you submit a pull request, please follow these guidelines:
  ^^^^^^^^^^^^^^^^
  * Updated the contribution guidelines. (:issue:`868`, :pull:`869`).
 
- If this is your first contribution to `Ouranosinc/xclim`, we ask that you also add your name to the `AUTHORS.rst <https://github.com/Ouranosinc/xclim/blob/master/AUTHORS.rst>`_, under *Contributors* as well as to the `.zenodo.json <https://github.com/Ouranosinc/xclim/blob/master/.zenodo.json>`_, at the end of the *creators* block.
+ If this is your first contribution to `Ouranosinc/xclim`, we ask that you also add your name to the `AUTHORS.rst <https://github.com/Ouranosinc/xclim/blob/main/AUTHORS.rst>`_, under *Contributors* as well as to the `.zenodo.json <https://github.com/Ouranosinc/xclim/blob/main/.zenodo.json>`_, at the end of the *creators* block.
 
 Updating Testing Data
 ~~~~~~~~~~~~~~~~~~~~~

diff --git a/README.rst b/README.rst
@@ -87,7 +87,7 @@ Contributing to xclim
 * If you would like to contribute code or documentation (which is greatly appreciated!), check out the `Contributing Guidelines`_ before you begin!
 
 .. _issue tracker: https://github.com/Ouranosinc/xclim/issues
-.. _Contributing Guidelines: https://github.com/Ouranosinc/xclim/blob/master/CONTRIBUTING.rst
+.. _Contributing Guidelines: https://github.com/Ouranosinc/xclim/blob/main/CONTRIBUTING.rst
 
 How to cite this library
 ------------------------
@@ -103,7 +103,7 @@ License
 This is free software: you can redistribute it and/or modify it under the terms of the `Apache License 2.0`_. A copy of this license is provided in the code repository (`LICENSE`_).
 
 .. _Apache License 2.0: https://opensource.org/license/apache-2-0/
-.. _LICENSE: https://github.com/Ouranosinc/xclim/blob/master/LICENSE
+.. _LICENSE: https://github.com/Ouranosinc/xclim/blob/main/LICENSE
 
 Credits
 -------
@@ -161,7 +161,7 @@ This package was created with Cookiecutter_ and the `audreyfeldroy/cookiecutter-
  :alt: JOSS
 
 .. |license| image:: https://img.shields.io/github/license/Ouranosinc/xclim.svg
- :target: https://github.com/Ouranosinc/xclim/blob/master/LICENSE
+ :target: https://github.com/Ouranosinc/xclim/blob/main/LICENSE
  :alt: License
 
 .. |security| image:: https://bestpractices.coreinfrastructure.org/projects/6041/badge
@@ -184,12 +184,12 @@ This package was created with Cookiecutter_ and the `audreyfeldroy/cookiecutter-
  :target: https://github.com/psf/black
  :alt: Python Black
 
-.. |logo| image:: https://raw.githubusercontent.com/Ouranosinc/xclim/master/docs/logos/xclim-logo-small.png
+.. |logo| image:: https://raw.githubusercontent.com/Ouranosinc/xclim/main/docs/logos/xclim-logo-small.png
  :target: https://github.com/Ouranosinc/xclim
  :alt: Xclim
 
-.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/Ouranosinc/xclim/master.svg
- :target: https://results.pre-commit.ci/latest/github/Ouranosinc/xclim/master
+.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/Ouranosinc/xclim/main.svg
+ :target: https://results.pre-commit.ci/latest/github/Ouranosinc/xclim/main
  :alt: pre-commit.ci status
 
 .. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json

diff --git a/docs/conf.py b/docs/conf.py
@@ -47,15 +47,15 @@
 for module in ("atmos", "generic", "land", "seaIce", "icclim", "anuclim"):
  for key, ind in getattr(xclim.indicators, module).__dict__.items():
  if hasattr(ind, "_registry_id") and ind._registry_id in registry: # noqa
- indicators[ind._registry_id] = {
+ indicators[ind._registry_id] = { # noqa
  "realm": ind.realm,
  "title": ind.title,
  "name": key,
  "module": module,
  "abstract": ind.abstract,
  "vars": {
  param_name: f"{param.description}"
- for param_name, param in ind._all_parameters.items()
+ for param_name, param in ind._all_parameters.items() # noqa
  if param.kind < 2 and not param.injected
  },
  "keywords": ind.keywords.split(","),
@@ -221,7 +221,7 @@ class XCStyle(AlphaStyle):
 
 .. only:: html
 
- `Download this notebook from github. <https://github.com/Ouranosinc/xclim/raw/master/docs/{{ docname }}>`_
+ `Download this notebook from github. <https://github.com/Ouranosinc/xclim/raw/main/docs/{{ docname }}>`_
 """
 nbsphinx_timeout = 300
 nbsphinx_allow_errors = False
@@ -234,8 +234,8 @@ class XCStyle(AlphaStyle):
 # If a list of string, all suffixes will be understood as restructured text variants.
 source_suffix = [".rst"]
 
-# The master toctree document.
-master_doc = "index"
+# The root toctree document.
+root_doc = "index"
 
 # General information about the project.
 project = "xclim"
@@ -338,7 +338,7 @@ class XCStyle(AlphaStyle):
 # [howto, manual, or own class]).
 latex_documents = [
  (
- master_doc,
+ root_doc,
  "xclim.tex",
  "xclim Documentation",
  "xclim Project Development Team",
@@ -350,7 +350,15 @@ class XCStyle(AlphaStyle):
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [(master_doc, "xclim", "xclim Documentation", [author], 1)]
+man_pages = [
+ (
+ root_doc,
+ "xclim",
+ "xclim Documentation",
+ [author],
+ 1,
+ )
+]
 
 # -- Options for Texinfo output ----------------------------------------
 
@@ -359,7 +367,7 @@ class XCStyle(AlphaStyle):
 # dir menu entry, description, category)
 texinfo_documents = [
  (
- master_doc,
+ root_doc,
  "xclim",
  "xclim Documentation",
  author,

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -130,7 +130,7 @@ Or download the `tarball`_:
 
 .. code-block:: shell
 
- $ curl -OL https://github.com/Ouranosinc/xclim/tarball/master
+ $ curl -OL https://github.com/Ouranosinc/xclim/tarball/main
 
 Once you have extracted a copy of the source, you can install it with pip:
 
@@ -145,7 +145,7 @@ Alternatively, you can also install a local development copy via `flit`_:
  $ flit install [--symlink] xclim
 
 .. _Github repo: https://github.com/Ouranosinc/xclim
-.. _tarball: https://github.com/Ouranosinc/xclim/tarball/master
+.. _tarball: https://github.com/Ouranosinc/xclim/tarball/main
 .. _flit: https://flit.pypa.io/en/stable
 
 Creating a Conda environment

diff --git a/docs/notebooks/extendxclim.ipynb b/docs/notebooks/extendxclim.ipynb
@@ -183,7 +183,7 @@
  "\n",
  "A particularity of Indicators is that each instance corresponds to a single class: when creating a new indicator, a new class is automatically created. This is done for easy construction of indicators based on others, like shown further down.\n",
  "\n",
- "See the [class documentation](../api.rst#indicator-tools) for more info on the meaning of each attribute. The [indicators](https://github.com/Ouranosinc/xclim/tree/master/xclim/indicators) module contains over 50 examples of indicators to draw inspiration from.\n",
+ "See the [class documentation](../api.rst#indicator-tools) for more info on the meaning of each attribute. The [indicators](https://github.com/Ouranosinc/xclim/tree/main/xclim/indicators) module contains over 50 examples of indicators to draw inspiration from.\n",
  "\n",
  "### Identifier vs python name\n",
  "\n",
@@ -299,7 +299,7 @@
  "cell_type": "markdown",
  "metadata": {},
  "source": [
- "While the former method is shorter, the latter is what xclim uses internally, as it provides some clean code structure. See [the code in the GitHub repo](https://github.com/Ouranosinc/xclim/tree/master/xclim/indicators).\n",
+ "While the former method is shorter, the latter is what xclim uses internally, as it provides some clean code structure. See [the code in the GitHub repo](https://github.com/Ouranosinc/xclim/tree/main/xclim/indicators).\n",
  "\n",
  "## Virtual modules\n",
  "\n",