Merge branch 'feature/v0.2.5' into develop

colour-science · Dec 17, 2023 · 42269cc · 42269cc
2 parents 2b341f0 + 513ecdf
commit 42269cc
Show file tree

Hide file tree

Showing 25 changed files with 435 additions and 403 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -1,7 +1,7 @@
 name: Bug Report
 description: Report an issue or a bug.
 title: "[BUG]: << Please use a comprehensive title... >>"
-labels: [ Defect ]
+labels: [Defect]
 
 body:
   - type: markdown

diff --git a/.github/ISSUE_TEMPLATE/documentation-improvement.yml b/.github/ISSUE_TEMPLATE/documentation-improvement.yml
@@ -1,7 +1,7 @@
 name: Documentation Improvement
 description: Report a documentation improvement.
 title: "[DOCUMENTATION]: << Please use a comprehensive title... >>"
-labels: [ Documentation ]
+labels: [Documentation]
 
 body:
   - type: markdown

diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml
@@ -1,7 +1,7 @@
 name: Feature Request
 description: Suggest a new feature to implement.
 title: "[FEATURE]: << Please use a comprehensive title... >>"
-labels: [ Feature ]
+labels: [Feature]
 
 body:
   - type: markdown

diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml
@@ -1,7 +1,7 @@
 name: Question
 description: Ask a question.
 title: "[DISCUSSION]: << Please use a comprehensive title... >>"
-labels: [ Discussion ]
+labels: [Discussion]
 
 body:
   - type: markdown

diff --git a/.github/workflows/continuous-integration-documentation.yml b/.github/workflows/continuous-integration-documentation.yml
@@ -8,41 +8,41 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-22.04]
-        python-version: [3.11]
+        python-version: [3.12]
       fail-fast: false
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v1
-    - name: Environment Variables
-      run: |
-        echo "CI_PYTHON_VERSION=${{ matrix.python-version }}" >> $GITHUB_ENV
-        echo "CI_PACKAGE=colour_demosaicing" >> $GITHUB_ENV
-        echo "CI_SHA=${{ github.sha }}" >> $GITHUB_ENV
-        echo "MPLBACKEND=AGG" >> $GITHUB_ENV
-        echo "COLOUR_SCIENCE__DOCUMENTATION_BUILD=True" >> $GITHUB_ENV
-      shell: bash
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install Dependencies
-      run: |
-        sudo apt-get update
-        sudo apt-get --yes install latexmk texlive-full
-    - name: Install Poetry
-      env:
-        POETRY_VERSION: 1.4.0
-      run: |
-        curl -sSL https://install.python-poetry.org | POETRY_HOME=$HOME/.poetry python3 -
-        echo "$HOME/.poetry/bin" >> $GITHUB_PATH
-      shell: bash
-    - name: Install Package Dependencies
-      run: |
-        poetry run python -m pip install --upgrade pip
-        poetry install
-        poetry run python -c "import imageio;imageio.plugins.freeimage.download()"
-      shell: bash
-    - name: Build Documentation
-      run: |
-        poetry run invoke docs
-      shell: bash
+      - uses: actions/checkout@v1
+      - name: Environment Variables
+        run: |
+          echo "CI_PYTHON_VERSION=${{ matrix.python-version }}" >> $GITHUB_ENV
+          echo "CI_PACKAGE=colour_demosaicing" >> $GITHUB_ENV
+          echo "CI_SHA=${{ github.sha }}" >> $GITHUB_ENV
+          echo "MPLBACKEND=AGG" >> $GITHUB_ENV
+          echo "COLOUR_SCIENCE__DOCUMENTATION_BUILD=True" >> $GITHUB_ENV
+        shell: bash
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get --yes install latexmk texlive-full
+      - name: Install Poetry
+        env:
+          POETRY_VERSION: 1.4.0
+        run: |
+          curl -sSL https://install.python-poetry.org | POETRY_HOME=$HOME/.poetry python3 -
+          echo "$HOME/.poetry/bin" >> $GITHUB_PATH
+        shell: bash
+      - name: Install Package Dependencies
+        run: |
+          poetry run python -m pip install --upgrade pip
+          poetry install
+          poetry run python -c "import imageio;imageio.plugins.freeimage.download()"
+        shell: bash
+      - name: Build Documentation
+        run: |
+          poetry run invoke docs
+        shell: bash
diff --git a/.github/workflows/continuous-integration-quality-unit-tests.yml b/.github/workflows/continuous-integration-quality-unit-tests.yml
@@ -8,55 +8,55 @@ jobs:
     strategy:
       matrix:
         os: [macOS-latest, ubuntu-22.04, windows-latest]
-        python-version: [3.9, '3.10', 3.11]
+        python-version: [3.9, "3.10", 3.11, 3.12]
       fail-fast: false
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v1
-      with:
-        submodules: true
-    - name: Environment Variables
-      run: |
-        echo "CI_PYTHON_VERSION=${{ matrix.python-version }}" >> $GITHUB_ENV
-        echo "CI_PACKAGE=colour_demosaicing" >> $GITHUB_ENV
-        echo "CI_SHA=${{ github.sha }}" >> $GITHUB_ENV
-        echo "COVERALLS_REPO_TOKEN=${{ secrets.COVERALLS_REPO_TOKEN }}" >> $GITHUB_ENV
-      shell: bash
-    - name: Set up Python 3.9 for Pre-Commit
-      uses: actions/setup-python@v1
-      with:
-        python-version: 3.9
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install Poetry
-      env:
-        POETRY_VERSION: 1.4.0
-      run: |
-        curl -sSL https://install.python-poetry.org | POETRY_HOME=$HOME/.poetry python3 -
-        echo "$HOME/.poetry/bin" >> $GITHUB_PATH
-      shell: bash
-    - name: Install Package Dependencies
-      run: |
-        poetry run python -m pip install --upgrade pip
-        poetry install
-        poetry run python -c "import imageio;imageio.plugins.freeimage.download()"
-      shell: bash
-    - name: Pre-Commit (All Files)
-      run: |
-        poetry run pre-commit run --all-files
-      shell: bash
-    - name: Test Optimised Python Execution
-      run: |
-        poetry run python -OO -c "import $CI_PACKAGE"
-      shell: bash
-    - name: Test with Pytest
-      run: |
-        poetry run python -W ignore -m pytest --doctest-modules --ignore=$CI_PACKAGE/examples --cov=$CI_PACKAGE $CI_PACKAGE
-      shell: bash
-    - name: Upload Coverage to coveralls.io
-      if: matrix.os == 'macOS-latest' && matrix.python-version == '3.11'
-      run: |
-        if [ -z "$COVERALLS_REPO_TOKEN" ]; then echo \"COVERALLS_REPO_TOKEN\" secret is undefined!; else poetry run coveralls; fi
-      shell: bash
+      - uses: actions/checkout@v1
+        with:
+          submodules: true
+      - name: Environment Variables
+        run: |
+          echo "CI_PYTHON_VERSION=${{ matrix.python-version }}" >> $GITHUB_ENV
+          echo "CI_PACKAGE=colour_demosaicing" >> $GITHUB_ENV
+          echo "CI_SHA=${{ github.sha }}" >> $GITHUB_ENV
+          echo "COVERALLS_REPO_TOKEN=${{ secrets.COVERALLS_REPO_TOKEN }}" >> $GITHUB_ENV
+        shell: bash
+      - name: Set up Python 3.9 for Pre-Commit
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.9
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Poetry
+        env:
+          POETRY_VERSION: 1.4.0
+        run: |
+          curl -sSL https://install.python-poetry.org | POETRY_HOME=$HOME/.poetry python3 -
+          echo "$HOME/.poetry/bin" >> $GITHUB_PATH
+        shell: bash
+      - name: Install Package Dependencies
+        run: |
+          poetry run python -m pip install --upgrade pip
+          poetry install
+          poetry run python -c "import imageio;imageio.plugins.freeimage.download()"
+        shell: bash
+      - name: Pre-Commit (All Files)
+        run: |
+          poetry run pre-commit run --all-files
+        shell: bash
+      - name: Test Optimised Python Execution
+        run: |
+          poetry run python -OO -c "import $CI_PACKAGE"
+        shell: bash
+      - name: Test with Pytest
+        run: |
+          poetry run python -W ignore -m pytest --doctest-modules --ignore=$CI_PACKAGE/examples --cov=$CI_PACKAGE $CI_PACKAGE
+        shell: bash
+      - name: Upload Coverage to coveralls.io
+        if: matrix.os == 'macOS-latest' && matrix.python-version == '3.11'
+        run: |
+          if [ -z "$COVERALLS_REPO_TOKEN" ]; then echo \"COVERALLS_REPO_TOKEN\" secret is undefined!; else poetry run coveralls; fi
+        shell: bash
diff --git a/.github/workflows/continuous-integration-static-type-checking.yml b/.github/workflows/continuous-integration-static-type-checking.yml
@@ -8,22 +8,22 @@ jobs:
     strategy:
       matrix:
         os: [macOS-latest]
-        python-version: [3.11]
+        python-version: [3.12]
       fail-fast: false
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v1
-    - name: Environment Variables
-      run: |
-        echo "CI_PACKAGE=colour_demosaicing" >> $GITHUB_ENV
-      shell: bash
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install Package Dependencies
-      run: |
-        pip install -r requirements.txt
-    - name: Static Type Checking
-      run: |
-        pyright --skipunannotated
+      - uses: actions/checkout@v1
+      - name: Environment Variables
+        run: |
+          echo "CI_PACKAGE=colour_demosaicing" >> $GITHUB_ENV
+        shell: bash
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Package Dependencies
+        run: |
+          pip install -r requirements.txt
+      - name: Static Type Checking
+        run: |
+          pyright --skipunannotated
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,19 +1,55 @@
 repos:
--   repo: https://github.com/ikamensh/flynt/
-    rev: '1.0.1'
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v4.5.0"
     hooks:
-    -   id: flynt
--   repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: 'v0.0.285'
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-yaml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: name-tests-test
+        args: ["--pytest-test-first"]
+      - id: requirements-txt-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.6
     hooks:
-    - id: ruff
--   repo: https://github.com/psf/black
-    rev: 23.7.0
+      - id: codespell
+        exclude: "BIBLIOGRAPHY.bib|CONTRIBUTORS.rst|.*.ipynb"
+  - repo: https://github.com/ikamensh/flynt
+    rev: "1.0.1"
     hooks:
-    - id: black
-      language_version: python3.9
--   repo: https://github.com/keewis/blackdoc
-    rev: v0.3.8
+      - id: flynt
+        args: [--verbose]
+  - repo: https://github.com/PyCQA/isort
+    rev: "5.12.0"
     hooks:
-    - id: blackdoc
-      language_version: python3.9
+      - id: isort
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: "v0.1.6"
+    hooks:
+      - id: ruff
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 23.11.0
+    hooks:
+      - id: black
+        language_version: python3.9
+  - repo: https://github.com/adamchainz/blacken-docs
+    rev: 1.16.0
+    hooks:
+      - id: blacken-docs
+        language_version: python3.9
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: "v3.1.0"
+    hooks:
+      - id: prettier
+        exclude: config-aces-reference.ocio.yaml
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: "v1.10.0"
+    hooks:
+      - id: rst-backticks
+      - id: rst-directive-colons
+      - id: rst-inline-touching-normal
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -6,12 +6,12 @@ build:
     python: "3.11"
 
 sphinx:
-   configuration: docs/conf.py
+  configuration: docs/conf.py
 
 formats:
   - htmlzip
   - pdf
 
 python:
   install:
-    - requirements: docs/requirements.txt
+    - requirements: docs/requirements.txt
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -8,23 +8,22 @@ In the interest of fostering an open and welcoming environment, we as contributo
 
 Examples of behavior that contributes to creating a positive environment include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others’ private information, such as a physical or electronic address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others’ private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
 
 ## Our Responsibilities
 
-
 Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
 
 Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
@@ -35,7 +34,6 @@ This Code of Conduct applies within all project spaces, and it also applies when
 
 ## Enforcement
 
-
 Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting Thomas Mansencal and Michael Mauderer via email at thomas@colour-science.org and michael@colour-science.org respectively. 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. Further details of specific enforcement policies may be posted separately.
 
 Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership.
@@ -46,6 +44,5 @@ This Code of Conduct is adapted from the Contributor Covenant, version 1.4, avai
 
 For answers to common questions about this code of conduct, see [https://www.contributor-covenant.org/faq][faq].
 
-
 [homepage]: https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
-[faq]: https://www.contributor-covenant.org/faq
+[faq]: https://www.contributor-covenant.org/faq