Fix CI working directory (#4)

Author: Krastanov

.github/workflows/ci.yml

@@ -5,14 +5,21 @@ on:
     branches: ["main", "master"]
   pull_request:
 
+concurrency:
+  # group by workflow and ref; the last slightly strange component ensures that for pull
+  # requests, we limit to 1 concurrent job, but for the master branch we don't
+  group: ${{ github.workflow }}-${{ github.ref }}-${{ (github.ref != 'refs/heads/master' && github.ref != 'refs/heads/main') || github.run_number }}
+  # Cancel intermediate builds, but only if it is a pull request build.
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+
 jobs:
   test:
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ["3.10", "3.11", "3.12", "3.13", "3"]
+        python-version: ["3.11", "3.12", "3.13", "3"]
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
@@ -21,10 +28,7 @@ jobs:
       - uses: astral-sh/setup-uv@v3
       - name: Install dependencies
         run: uv sync --dev
-        working-directory: pyquantumclifford
       - name: Run tests
         run: uv run pytest
-        working-directory: pyquantumclifford
       - name: Ruff
         run: uv run ruff check .
-        working-directory: pyquantumclifford

README.md

@@ -1,23 +1,33 @@
 # pyquantumclifford
 
-Thin Python wrapper for `QuantumClifford.jl` and `QuantumClifford.ECC` using the JuliaPy stack.
+Thin Python wrapper for [`QuantumClifford.jl`](https://qc.quantumsavory.org/stable/) and [`QuantumClifford.ECC`](https://qc.quantumsavory.org/stable/ECC_API/) using the JuliaPy stack.
+Supports extremely fast Stabilizer state simulations, weakly non-Clifford dynamics, and generation of many modern quantum error correcting codes.
+
+## Instalation
+
+```
+pip install pyquantumclifford
+```
+
+or
+
+```
+uv add pyquantumclifford
+```
+
+On first `import` the Julia runtime will be downloaded and QuantumClifford.jl will be compiled (optimized for your hardware). This is a slow process, might take around 5 minutes.
+
+Optional: Having [`juliaup`](https://github.com/JuliaLang/juliaup) installed in your system (and available in your PATH) makes managing Julia versions much simpler behind the scenes. Consider manually installing `juliaup` before installing `pyquantumclifford`. The install command is `curl -fsSL https://install.julialang.org | sh` for a selfcontained install in `~/.julia` that you can delete at any time.
 
 ## Usage
 
 ```python
 import numpy as np
 from pyquantumclifford import QuantumClifford, ECC
 
-# Create an empty tableau and stabilizer
+# Optional, for calling arbitrary Julia code
 from juliacall import Main as jl
 
-empty_tab = QuantumClifford.Tableau(
-    jl.zeros(jl.UInt8, 0),
-    0,
-    jl.zeros(jl.UInt8, 0, 0),
-)
-stabilizer = QuantumClifford.Stabilizer(empty_tab)
-
 # Simple ECC code
 code = ECC.Shor9()
 
@@ -29,5 +39,5 @@ np.array(ECC.parity_matrix(ECC.Shor9()))
 
 ## Notes
 
-- Julia dependencies are declared in `juliapkg.json` and installed by JuliaPkg.
+- Windows is not supported due to the Oscar computer algebra system being unavailable on it. Use WSL on Windows.
 - `juliacall` provides access to Julia modules from Python.

pyproject.toml

@@ -1,12 +1,12 @@
 [project]
 name = "pyquantumclifford"
-version = "0.1.0"
-description = "Thin Python wrapper for the Julia library QuantumClifford.jl and QuantumClifford.ECC"
+version = "0.10.1"
+description = "Thin Python wrapper for the Julia library QuantumClifford.jl and QuantumClifford.ECC. Supports extremely fast Stabilizer state simulations, weakly non-Clifford dynamics, and generation of many modern quantum error correcting codes."
 readme = "README.md"
 authors = [
     { name = "Stefan Krastanov", email = "stefan@krastanov.org" }
 ]
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 dependencies = [
     "juliacall>=0.9.27",
     "juliapkg>=0.1.13",

juliapkg.json src/pyquantumclifford/juliapkg.jsonjuliapkg.json renamed to src/pyquantumclifford/juliapkg.json

@@ -1,9 +1,9 @@
 {
-  "julia": "1.12",
+  "julia": "^1.10",
   "packages": {
     "QuantumClifford": {
       "uuid": "0525e862-1e90-11e9-3e4d-1b39d7109de1",
-      "version": "0.10"
+      "version": "0.10.1"
     },
     "Nemo": {
       "uuid": "2edaba10-b0f1-5616-af89-8c11ac63239a"