Support Lorentz spinors as complex quaternions

.github/workflows/CI.yml

@@ -65,6 +65,7 @@ jobs:
     permissions:
       contents: write
       statuses: write
+      pull-requests: write
     steps:
       - uses: actions/checkout@v5
       - uses: julia-actions/setup-julia@v2
@@ -80,4 +81,9 @@ jobs:
             using Documenter: DocMeta, doctest
             using Quaternionic
             DocMeta.setdocmeta!(Quaternionic, :DocTestSetup, :(using Quaternionic); recursive=true)
-            doctest(Quaternionic)'
+            doctest(Quaternionic)'
+      - uses: marocchino/sticky-pull-request-comment@v2
+        if: github.event_name == 'pull_request'
+        with:
+          message: |
+            [Documentation preview](https://moble.github.io/Quaternionic.jl/previews/PR${{ github.event.pull_request.number }}/)

.gitignore

@@ -35,3 +35,8 @@ benchmark/results.md
 
 # Ignore my notes
 notes
+docs/src/local_notes
+
+# LLM/AI tool configuration
+.claude/
+MEMORY.md

Project.toml

@@ -1,7 +1,10 @@
 name = "Quaternionic"
 uuid = "0756cd96-85bf-4b6f-a009-b5012ea7a443"
+version = "4.0.0"
 authors = ["Michael Boyle <michael.oliver.boyle@gmail.com>"]
-version = "3.1.1"
+
+[workspace]
+projects = ["test", "docs"]
 
 [deps]
 LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
@@ -10,7 +13,6 @@ PrecompileTools = "aea7be01-6a6a-4083-8856-8a6e6704d82a"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 Requires = "ae029012-a4dd-5104-9daa-d747884805df"
 StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
-TestItems = "1c621080-faea-4a02-84b6-bbd5e436b8fe"
 
 [weakdeps]
 ChainRules = "082447d4-558c-5d27-93f4-14fc19e9eca2"
@@ -27,28 +29,19 @@ Zygote = "e88e6eb3-aa80-5325-afca-941959d7151f"
 ZygoteRules = "700de1a5-db45-46bc-99cf-38207098b444"
 
 [extensions]
-QuaternionicChainRulesExt = ["ChainRules", "ChainRulesCore"]
 QuaternionicChainRulesCoreExt = "ChainRulesCore"
+QuaternionicChainRulesExt = ["ChainRules", "ChainRulesCore"]
 QuaternionicFastDifferentiationExt = "FastDifferentiation"
 QuaternionicForwardDiffExt = "ForwardDiff"
 QuaternionicLatexifyExt = "Latexify"
 QuaternionicSymbolicsExt = "Symbolics"
 QuaternionicZygoteExt = ["Zygote", "ZygoteRules", "ChainRulesCore", "StaticArraysCore"]
 
 [compat]
-Aqua = "0.8"
 ChainRules = "1.72.6"
 ChainRulesCore = "1"
-ChainRulesTestUtils = "1.13.0"
-Coverage = "1.7.0"
-DifferentiationInterface = "0.7.8"
-DifferentiationInterfaceTest = "0.10.2"
-Documenter = "1.14.1"
-DoubleFloats = "1.4.3"
-EllipsisNotation = "1.8.0"
 Enzyme = "0.13.82"
 FastDifferentiation = "0.3.15, 0.4"
-FiniteDifferences = "0.12.33"
 ForwardDiff = "0.10, 1"
 GenericLinearAlgebra = "0.3.11"
 LaTeXStrings = "1"
@@ -58,71 +51,9 @@ Mooncake = "0.4.161"
 PrecompileTools = "1.2"
 Random = "1"
 Requires = "1"
-ReverseDiff = "1.16.1"
 StaticArrays = "1.8.1"
 StaticArraysCore = "1.4.3"
 Symbolics = "0.1, 1, 2, 3, 4, 5, 6, 7"
-Test = "1.11.0"
-TestItemRunner = "1"
-TestItems = "1"
 Zygote = "0.7.10"
 ZygoteRules = "0.2.7"
 julia = "1.6"
-
-
-[extras]
-Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
-ChainRules = "082447d4-558c-5d27-93f4-14fc19e9eca2"
-ChainRulesCore = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4"
-ChainRulesTestUtils = "cdddcdb0-9152-4a09-a978-84456f9df70a"
-Coverage = "a2441757-f6aa-5fb2-8edb-039e3f45d037"
-DifferentiationInterface = "a0c0ee7d-e4b9-4e03-894e-1c5f64a51d63"
-DifferentiationInterfaceTest = "a82114a7-5aa3-49a8-9643-716bb13727a3"
-Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
-DoubleFloats = "497a8b3b-efae-58df-a0af-a86822472b78"
-EllipsisNotation = "da5c29d0-fa7d-589e-88eb-ea29b0a81949"
-Enzyme = "7da242da-08ed-463a-9acd-ee780be4f1d9"
-FastDifferentiation = "eb9bf01b-bf85-4b60-bf87-ee5de06c00be"
-FiniteDifferences = "26cc04aa-876d-5657-8c51-4c34ba976000"
-ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
-LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
-Mooncake = "da2b9cff-9c12-43a0-ae48-6db2b0edb7d6"
-Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
-ReverseDiff = "37e2e3b7-166d-5795-8a7a-e32c996b4267"
-StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
-StaticArraysCore = "1e83bf80-4336-4d27-bf5d-d5a4f845583c"
-Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
-TestItemRunner = "f8b46487-2199-4994-9208-9a1283c18c0a"
-Zygote = "e88e6eb3-aa80-5325-afca-941959d7151f"
-ZygoteRules = "700de1a5-db45-46bc-99cf-38207098b444"
-
-
-[targets]
-test = [
-    "Aqua",
-    "ChainRules",
-    "ChainRulesCore",
-    "ChainRulesTestUtils",
-    "Coverage",
-    "DifferentiationInterface",
-    "DifferentiationInterfaceTest",
-    "Documenter",
-    "DoubleFloats",
-    "EllipsisNotation",
-    "Enzyme",
-    "FastDifferentiation",
-    "FiniteDifferences",
-    "ForwardDiff",
-    "GenericLinearAlgebra",
-    "LinearAlgebra",
-    "Mooncake",
-    "Random",
-    "ReverseDiff",
-    "StaticArrays",
-    "StaticArraysCore",
-    "Symbolics",
-    "Test",
-    "TestItemRunner",
-    "Zygote",
-    "ZygoteRules",
-]

docs/Project.toml

@@ -12,3 +12,6 @@ Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [compat]
 Documenter = "1"
+
+[sources]
+Quaternionic = {path = ".."}

docs/local_notes.jl

@@ -0,0 +1,26 @@
+# Conditionally include private local notes when building docs.  The directory
+# `docs/src/local_notes` should be a symlink into a private notes git repo.  When absent
+# (e.g., in CI), `notes_pages` and `notes_remotes` are empty and the build proceeds
+# normally.
+
+function local_notes()
+    notes_src = joinpath(@__DIR__, "src", "local_notes")
+
+    if isdir(notes_src)
+        files = filter(f -> endswith(f, ".md"), readdir(notes_src; sort=true))
+        notes_pages = isempty(files) ? [] : ["Local Notes" => map(f -> "local_notes/$f", files)]
+        try
+            notes_root = readchomp(`git -C $(realpath(notes_src)) rev-parse --show-toplevel`)
+            notes_remote_url = readchomp(`git -C $notes_root remote get-url origin`)
+            # Parse both SSH (git@github.com:user/repo.git) and HTTPS (https://github.com/user/repo.git)
+            notes_slug = replace(notes_remote_url, r"^.*github\.com[:/]" => "", r"\.git$" => "")
+            notes_remotes = Dict(notes_root => Documenter.Remotes.GitHub(notes_slug))
+            return (notes_pages, notes_remotes)
+        catch err
+            @warn "Skipping local notes git remote configuration; docs build will continue without remotes for local notes." exception=(err, catch_backtrace()) notes_src=notes_src
+            return (notes_pages, Dict())
+        end
+    else
+        return ([], Dict())
+    end
+end

docs/make.jl

@@ -14,6 +14,9 @@ bib = CitationBibliography(
 
 DocMeta.setdocmeta!(Quaternionic, :DocTestSetup, :(using Quaternionic); recursive=true)
 
+include("local_notes.jl")
+(notes_pages, notes_remotes) = local_notes()
+
 makedocs(;
     plugins=[bib],
     sitename="Quaternionic.jl",
@@ -26,12 +29,16 @@ makedocs(;
     ),
     authors="Michael Boyle <michael.oliver.boyle@gmail.com>",
     repo=Remotes.GitHub("moble", "Quaternionic.jl"),
+    remotes=notes_remotes,
     pages=[
         "Introduction" => "index.md",
         "Basics" => "manual.md",
         "Functions of time" => "functions_of_time.md",
         "Differentiating by quaternions" => "differentiation.md",
-        "All functions" => "functions.md"
+        "All functions" => "functions.md",
+        "Geometric Algebra" => "geometric_algebra.md",
+        "Spacetime Algebra" => "spacetime_algebra.md",
+        notes_pages...,
     ],
     # doctest = false,
     doctestfilters = [

docs/serve.jl

@@ -0,0 +1,7 @@
+# This simply uses `make.jl` in this directory to build the docs, then serves them locally.
+# Run `julia --project=docs docs/serve.jl` from the top directory to execute this script.
+
+#using Quaternionic
+import LiveServer: servedocs
+
+servedocs(; launch_browser=true)