cadjoint 0.1.0__tar.gz

cadjoint-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

cadjoint-0.1.0/PKG-INFO

@@ -0,0 +1,300 @@
+Metadata-Version: 2.4
+Name: cadjoint
+Version: 0.1.0
+Summary: Fully differentiable CAD software built with JAX
+Author: Andrin Rehmann
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/andrinr/cadjoint
+Project-URL: Documentation, https://andrinr.github.io/cadjoint/
+Project-URL: Source, https://github.com/andrinr/cadjoint
+Project-URL: Issues, https://github.com/andrinr/cadjoint/issues
+Keywords: cad,jax,sdf,differentiable,optimization,fem
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: imageio>=2.37.2
+Requires-Dist: jax>=0.4.20
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: optax>=0.2.4
+Requires-Dist: optimistix>=0.0.10
+Provides-Extra: cuda
+Requires-Dist: jax[cuda12]>=0.4.20; extra == "cuda"
+Provides-Extra: fem
+Requires-Dist: jax-fem; extra == "fem"
+Requires-Dist: fenics-basix; extra == "fem"
+Requires-Dist: meshio; extra == "fem"
+Requires-Dist: gmsh; extra == "fem"
+Requires-Dist: petsc4py; extra == "fem"
+Requires-Dist: pyfiglet; extra == "fem"
+Requires-Dist: scipy; extra == "fem"
+Provides-Extra: tesseract
+Requires-Dist: tesseract-core[runtime]; extra == "tesseract"
+Requires-Dist: tesseract-jax; extra == "tesseract"
+Provides-Extra: gmsh
+Requires-Dist: gmsh; extra == "gmsh"
+Provides-Extra: stepcheck
+Requires-Dist: cadquery-ocp; python_version < "3.15" and extra == "stepcheck"
+Provides-Extra: viewer
+Requires-Dist: anywidget>=0.9.21; extra == "viewer"
+Requires-Dist: psutil>=5.9; extra == "viewer"
+Requires-Dist: pydantic>=2; extra == "viewer"
+Provides-Extra: editor
+Requires-Dist: jedi>=0.19.0; extra == "editor"
+Requires-Dist: ruff>=0.8.0; extra == "editor"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-xdist>=3.5; extra == "dev"
+Requires-Dist: pre-commit>=3.0.0; extra == "dev"
+Requires-Dist: matplotlib>=3.7.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: quartodoc>=0.7; extra == "docs"
+Requires-Dist: griffe<1.0; extra == "docs"
+Dynamic: license-file
+
+# cadjoint
+
+Differentiable code-first CAD: sketches, constraints, SDF geometry, meshing and
+FEM simulation composed into one function JAX can differentiate end to end.
+
+> [!WARNING]
+> The API is not stable. Expect breaking changes.
+
+[![The bracket scene in the cadjoint playground: with the pointer in vertex selection, the tip of the bracket's triangular gusset rib is dragged up the vertical web. The rib re-attaches where the pointer puts it and the smooth union re-blends the joint at frame rate while the plate and web stay put; the editor on the left holds the highlighted line rib_tip = Vector2(value=[-0.9, -0.62], free=True, ...). Then the camera makes one full turn around the bracket.](https://raw.githubusercontent.com/andrinr/cadjoint/main/docs/assets/motion/bracket-orbit-drag.webp)](https://andrinr.github.io/cadjoint/docs/viewer.html)
+
+*The handle under the pointer is a named `Vector2` in `scene.py`, and the
+joint it moves is a smooth union of three extrusions. Dragging it writes the
+parameter buffer the shader already reads, so the blend follows at frame
+rate; releasing it patches the literal in the source. The source is the
+model.*
+
+## The chain
+
+One Python program declares the whole thing, and every arrow is a derivative
+JAX can take:
+
+```
+sketch vertices ─► constraints ─► SDF ─► mesh ─► FEM solve ─► objective
+       └─────────────────────────── ∂J/∂θ ◄───────────────────────────┘
+```
+
+A sketch profile is a list of named `Vector2` parameters. Constraints are
+residuals on those parameters, solved by Newton projection onto the constraint
+manifold. Extruding or revolving the profile produces an SDF that *shares* those
+parameter objects. Dual contouring turns the field into a surface, TetGen or
+Gmsh fills it, and jax-fem or CalculiX solves on it. A study is declared in the
+scene beside the geometry it loads — here the end cap's `ThermalStudy`, a heat
+flux on the bearing boss and a fixed temperature on the flange — and solving it
+is one click, meshing included:
+
+[![The end cap's cap-conduction thermal study is run from the Simulate panel. Its mesh is declared as cut cells, so no volume mesh is built: the job chip counts up while the lattice's cut cells are assembled and solved, then the temperature field lands on the solid with its legend, and the part is turned with the field on it.](https://raw.githubusercontent.com/andrinr/cadjoint/main/docs/assets/motion/end-cap-solve.webp)](https://github.com/andrinr/cadjoint/blob/main/scenes/end_cap.py)
+
+The same study is a function of the sketch, so `jax.grad` reaches from its
+objective back to a fin's tip coordinate. An `Optimization` declared in the
+scene descends on that gradient, every step a mesh, a solve and an adjoint,
+projected back onto the constraints. The heat sink below starts deliberately
+overbuilt and slims as its peak temperature falls:
+
+[![The heat sink's cool-sink optimisation is run from the Optimize panel. Eight gradient steps, each a mesh, a thermal solve and an adjoint, replayed as a time-lapse: the fin comb reproportions as the peak temperature falls in the panel's trace.](https://raw.githubusercontent.com/andrinr/cadjoint/main/docs/assets/motion/heat-sink-optimize.webp)](https://github.com/andrinr/cadjoint/blob/main/scenes/starter.py)
+
+A work plane taken from a face (`SketchPlane.on(body.cap("+"))`) is an
+expression over the parent feature's parameters, so a boss extruded from it
+differentiates with respect to its parent's depth. While sketching, the plane
+of the sketch you touch is drawn with its origin and normal (every plane, in
+every mode, is one switch away); the sketch tool shows where a new one will
+land before it exists, and a plane written as literals can be taken by its
+frame and moved, which rewrites the `SketchPlane(origin=...)` in the source:
+
+[![The heat sink in the playground, switched to Sketch mode: no plane is drawn yet. The sketch tool is armed and a ghost frame labelled new sketch follows the pointer across the floor. Then the pointer lands on one of the fin comb's handles and the comb's plane appears — a translucent frame, an origin cross and a normal glyph, named — and stays once the handle is clicked; the plane is taken by its frame edge, the gizmo appears at its origin, and dragging the gizmo's Z arrow lifts the whole comb; the editor's SketchPlane(origin=[...]) literal is rewritten on release.](https://raw.githubusercontent.com/andrinr/cadjoint/main/docs/assets/motion/sketch-planes.webp)](https://github.com/andrinr/cadjoint/blob/main/scenes/starter.py)
+
+No boundary representation is stored: the field is the model, and every
+surface is derived from it at a resolution you choose.
+
+## What ships
+
+- **Geometry** — SDF primitives, smooth booleans, transforms, patterns;
+  sketches on work planes extruded, revolved or lofted into solids that share
+  their parameters; reference planes taken from faces, offsets and midplanes
+- **Constraints** — distance, angle, coincident, horizontal, vertical,
+  parallel, perpendicular, equal-length, point-on-line, fixed
+- **Materials** — a sourced catalogue carrying density, conductivity, elastic
+  constants and yield strength in SI, sampled per element by the solver
+- **Meshing** — dual contouring with sharp-feature vertices; TET4/TET10 through
+  TetGen, second-order tets through Gmsh, or a voxelize-and-snap HEX8 path;
+  OBJ, STL and faceted STEP export
+- **Simulation** — thermal and linear-elastic studies with programmatic node
+  selections, solved by jax-fem or CalculiX 2.23; a lattice-Boltzmann flow
+  prototype
+- **Optimization** — declared in the scene, descended with optax, every step
+  projected back onto the constraints
+- **Plugins** — every non-JAX component (meshers, solvers) is a
+  [Tesseract](https://github.com/pasteurlabs/tesseract-core) behind one
+  `apply`/`vjp` interface, run in-process, in a container or remotely
+- **Rendering** — a forward raymarcher in JAX, and a StableHLO → WGSL shader
+  compiler for the browser
+- **Playground** — a WebGPU app where every edit rewrites the Python source
+  that produced it
+
+## Install
+
+```bash
+pip install cadjoint         # pin an exact version: the API is not stable
+```
+
+From a checkout:
+
+```bash
+git clone https://github.com/andrinr/cadjoint
+cd cadjoint
+uv sync                      # CPU JAX — macOS, Linux, Windows
+uv sync --extra cuda         # Linux + NVIDIA GPU instead
+```
+
+Everything beyond the geometry core is an extra, one `--extra` per name:
+
+| Extra | Pulls in |
+| --- | --- |
+| `fem` | jax-fem finite-element stack (basix, meshio, petsc4py, gmsh) |
+| `tesseract` | tesseract-core + tesseract-jax, the plugin runtime |
+| `gmsh` | Gmsh in-process for the tet10 mesher (GPL, hence its own extra) |
+| `viewer` | Jupyter widget (`anywidget`) and the playground's process monitor (`psutil`) |
+| `editor` | playground lint, completion and signature help (`ruff`, `jedi`) |
+| `stepcheck` | OCCT validation of STEP exports (dev) |
+| `docs` | Quarto API reference (`quartodoc`) |
+
+Avoid `--all-extras` on macOS: `cuda` has no macOS wheels.
+
+`fem` is the one extra that compiles. petsc4py publishes no wheels, so
+`uv sync --extra fem` builds PETSc from source and needs a C compiler,
+gfortran and BLAS/LAPACK headers (`apt install build-essential gfortran
+libopenblas-dev` on Debian/Ubuntu). To skip the toolchain, run the solvers
+as Tesseracts: their images get PETSc from conda-forge and are published
+prebuilt to GHCR for amd64 and arm64, so Docker is the only requirement
+(see [prebuilt images](https://andrinr.github.io/cadjoint/docs/plugins.html#prebuilt-images)).
+
+### Supported platforms
+
+| Platform | `uv sync` | `uv sync --extra fem` |
+| --- | --- | --- |
+| Linux x86_64 | yes | compiles PETSc |
+| Linux ARM64 | yes | no: gmsh has no Linux ARM wheel |
+| macOS arm64 | yes | compiles PETSc |
+| macOS x86_64 (Intel) | no: jaxlib has no Intel-Mac wheel for Python 3.11+ | no |
+| Windows x86_64 | yes | no: PETSc does not build natively |
+
+Every "yes" is a fresh `uv sync --locked` and `import cadjoint` in
+[`install.yml`](https://github.com/andrinr/cadjoint/blob/main/.github/workflows/install.yml), run on each push. Where
+the `fem` column says no, the prebuilt solver Tesseracts above run the
+same solvers in Docker.
+
+## The playground
+
+```bash
+uv run cadjoint-viewer --open      # serves http://127.0.0.1:8765/
+```
+
+The editor on the left holds `scene.py`; the viewport shows the compiled
+field. Vertex handles, gizmos, material swatches, face picks, constraint chips
+and solver runs all write back into the source. A properties window follows
+the selection and shows every argument the call was written with: literals
+as fields you can edit, expressions as the text they are.
+
+[![The properties window in the playground. Clicking the fin comb's extrude row in the object tree fills the window with the call's arguments: the profile, the depth, which is the named parameter fin_depth, and the material. Typing a new depth and pressing Enter rewrites fin_depth's declaration in the editor and the comb deepens; choosing copper from the material dropdown rewrites the extrude call and the comb changes colour.](https://raw.githubusercontent.com/andrinr/cadjoint/main/docs/assets/motion/properties-window.webp)](https://github.com/andrinr/cadjoint/blob/main/scenes/starter.py)
+
+Three desks, Model, Sketch and Simulate, share one viewport. Studies solve
+with one click, results land in a labelled legend, and a declared
+optimization streams step by step and writes its optimized values into the
+program.
+
+The server only listens on localhost and compiles each edit in a timed child
+process, but it executes Python on your machine: only run code you trust.
+
+The [playground guide](https://andrinr.github.io/cadjoint/docs/viewer.html)
+walks through every window with recorded clips.
+
+## In Python
+
+```python
+from cadjoint.construction import PolygonProfile, SketchPlane, extrude
+from cadjoint.constraints import DistanceConstraint, satisfy_constraints
+from cadjoint.geometry import Scalar, Vector2
+from cadjoint.meshing import GridSpec, extract_mesh
+
+a = Vector2([0.0, 0.0], free=True, name="a")
+b = Vector2([1.0, 0.0], free=True, name="b")
+c = Vector2([1.0, 1.0], free=True, name="c")
+d = Vector2([0.0, 1.0], free=True, name="d")
+DistanceConstraint(a, b, 1.2)
+
+depth = Scalar(0.5, free=True, name="depth")
+block = extrude(PolygonProfile([a, b, c, d], plane=SketchPlane()), depth=depth)
+satisfy_constraints(block)          # projects a and b onto the constraint, in place
+
+grid = GridSpec.from_bounds((-0.5, -0.5, -0.5), (2.0, 2.0, 1.5), 32)
+mesh = extract_mesh(block, grid)
+```
+
+`functionalize(block)` returns a pure function of the free parameters, so
+`jax.grad` of anything downstream reaches `a`, `b`, `c`, `d` and `depth`. The
+[getting-started guide](https://andrinr.github.io/cadjoint/docs/getting-started.html)
+continues from here to meshing, a thermal study and an optimization;
+`examples/fem_bracket_optimization.py` runs the full chain from the command
+line, with the adjoint checked against finite differences at every boundary.
+
+## Documentation
+
+- [Getting started](https://andrinr.github.io/cadjoint/docs/getting-started.html)
+- [Differentiable meshing](https://andrinr.github.io/cadjoint/docs/meshing.html),
+  [simulation](https://andrinr.github.io/cadjoint/docs/simulation.html),
+  [optimization](https://andrinr.github.io/cadjoint/docs/optimization.html),
+  [materials](https://andrinr.github.io/cadjoint/docs/materials.html)
+- [Plugins](https://andrinr.github.io/cadjoint/docs/plugins.html): the Tesseract
+  contract, the shipped packages, containers and remote transports
+- [Rendering](https://andrinr.github.io/cadjoint/docs/rendering.html) and the
+  [playground](https://andrinr.github.io/cadjoint/docs/viewer.html)
+- [Research notes](https://github.com/andrinr/cadjoint/blob/main/research/README.md): design records for the meshing
+  pipeline, FEM integration, the flow solver, the constraint system, and the
+  measured [performance profile](https://github.com/andrinr/cadjoint/blob/main/research/performance.md)
+
+## Developing
+
+```bash
+uv run pytest tests -q --ignore=tests/fem   # fast gate
+uv run pytest tests/fem -q                  # needs the fem extra; CalculiX via CADJOINT_CCX
+uv run pre-commit install                   # ruff on commit
+```
+
+The playground UI is a Solid + TypeScript app in `frontend/`, built into
+`cadjoint/viewer/static` and committed, so installing cadjoint needs no Node
+toolchain. `npm run dev` proxies to a running server, `npm run build` refreshes
+the bundle, `npm test` and `npm run e2e` run the unit and Playwright suites.
+
+Docs need [Quarto](https://quarto.org/docs/get-started/) and the `docs` extra:
+`uv run quartodoc build` then `quarto preview`.
+
+Performance work is measured, not guessed: `benchmarks/jax_compile_profile.py`
+breaks a worker request into trace, lower, XLA compile and cache time per
+program, and [`research/performance.md`](https://github.com/andrinr/cadjoint/blob/main/research/performance.md) records what
+each lever bought.
+
+## History
+
+cadjoint was an entry in the
+[Tesseract Hackathon 2026](https://si-tesseract.discourse.group) (Track 01,
+inverse design and shape optimization). That state is frozen on the
+[`tesseract-hackathon-2026`](https://github.com/andrinr/cadjoint/tree/tesseract-hackathon-2026)
+branch. Inspired by [Fidget](https://www.mattkeeter.com/projects/fidget/) and
+[Inigo Quilez's distance functions](https://iquilezles.org/articles/distfunctions/).
+
+## License
+
+[Apache License 2.0](https://github.com/andrinr/cadjoint/blob/main/LICENSE).