Merge branch 'feature/v0.2.3' into develop

colour-science · Dec 20, 2023 · 1c7d8bf · 1c7d8bf
2 parents 8ae5008 + 2d162c8
commit 1c7d8bf
Show file tree

Hide file tree

Showing 56 changed files with 794 additions and 743 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_hdri" >> $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_hdri" >> $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,89 +8,89 @@ 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_hdri" >> $GITHUB_ENV
-        echo "CI_SHA=${{ github.sha }}" >> $GITHUB_ENV
-        echo "COVERALLS_REPO_TOKEN=${{ secrets.COVERALLS_REPO_TOKEN }}" >> $GITHUB_ENV
-        echo "MPLBACKEND=AGG" >> $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 Dependencies (macOS)
-      if: matrix.os == 'macOS-latest'
-      run: |
-        brew install dcraw exiftool
-        brew install --cask adobe-dng-converter
-      shell: bash
-    - name: Install Dependencies (Ubuntu)
-      if: matrix.os == 'ubuntu-22.04'
-      run: |
-        sudo apt-get update
-        sudo apt-get --yes install dcraw exiftool
-      shell: bash
-    - name: Install Dependencies (Windows)
-      if: matrix.os == 'windows-latest'
-      run: |
-        curl -L https://exiftool.org/exiftool-12.51.zip -o exiftool-12.51.zip
-        unzip -d exiftool exiftool-12.51.zip
-        cp exiftool/exiftool\(-k\).exe exiftool/exiftool.exe
-        echo "$PWD/exiftool" | sed -e 's/^\///' -e 's/\//\\/g' -e 's/^./\0:/' >> $GITHUB_PATH
-        curl -L https://cdn.fastpictureviewer.com/bin/dcraw.zip?v=201605100 -o dcraw.zip
-        unzip -d dcraw dcraw.zip
-        echo "$PWD/dcraw" | sed -e 's/^\///' -e 's/\//\\/g' -e 's/^./\0:/' >> $GITHUB_PATH
-      shell: bash
-    - name: Install Adobe DNG Converter (Windows)
-      if: matrix.os == 'windows-latest'
-      run: |
-        curl -L https://download.adobe.com/pub/adobe/dng/win/DNGConverter_11_4.exe -o DNGConverter_11_4.exe
-        DNGConverter_11_4.exe /S
-      shell: cmd
-    - name: Add Adobe DNG Converter to %PATH% (Windows)
-      if: matrix.os == 'windows-latest'
-      run: |
-        echo "C:\Program Files\Adobe\Adobe DNG Converter" >> $GITHUB_PATH
-      shell: bash
-    - 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
-      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_hdri" >> $GITHUB_ENV
+          echo "CI_SHA=${{ github.sha }}" >> $GITHUB_ENV
+          echo "COVERALLS_REPO_TOKEN=${{ secrets.COVERALLS_REPO_TOKEN }}" >> $GITHUB_ENV
+          echo "MPLBACKEND=AGG" >> $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 Dependencies (macOS)
+        if: matrix.os == 'macOS-latest'
+        run: |
+          brew install dcraw exiftool
+          brew install --cask adobe-dng-converter
+        shell: bash
+      - name: Install Dependencies (Ubuntu)
+        if: matrix.os == 'ubuntu-22.04'
+        run: |
+          sudo apt-get update
+          sudo apt-get --yes install dcraw exiftool
+        shell: bash
+      - name: Install Dependencies (Windows)
+        if: matrix.os == 'windows-latest'
+        run: |
+          curl -L https://exiftool.org/exiftool-12.51.zip -o exiftool-12.51.zip
+          unzip -d exiftool exiftool-12.51.zip
+          cp exiftool/exiftool\(-k\).exe exiftool/exiftool.exe
+          echo "$PWD/exiftool" | sed -e 's/^\///' -e 's/\//\\/g' -e 's/^./\0:/' >> $GITHUB_PATH
+          curl -L https://cdn.fastpictureviewer.com/bin/dcraw.zip?v=201605100 -o dcraw.zip
+          unzip -d dcraw dcraw.zip
+          echo "$PWD/dcraw" | sed -e 's/^\///' -e 's/\//\\/g' -e 's/^./\0:/' >> $GITHUB_PATH
+        shell: bash
+      - name: Install Adobe DNG Converter (Windows)
+        if: matrix.os == 'windows-latest'
+        run: |
+          curl -L https://download.adobe.com/pub/adobe/dng/win/DNGConverter_11_4.exe -o DNGConverter_11_4.exe
+          DNGConverter_11_4.exe /S
+        shell: cmd
+      - name: Add Adobe DNG Converter to %PATH% (Windows)
+        if: matrix.os == 'windows-latest'
+        run: |
+          echo "C:\Program Files\Adobe\Adobe DNG Converter" >> $GITHUB_PATH
+        shell: bash
+      - 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
+        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_hdri" >> $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_hdri" >> $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