Metadata-Version: 2.5
Name: joqed
Version: 0.0.1
Summary: JoQED - design flow for superconducting quantum chips and their control circuits
Project-URL: Homepage, https://github.com/joqed/joqed
Project-URL: Repository, https://github.com/joqed/joqed
Author: Roman Klimovich
License: Apache-2.0
License-File: LICENSE
Keywords: EDA,circuit-QED,design-flow,quantum,qubit,superconducting
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.11
Description-Content-Type: text/markdown

# JoQED

**Quantum control-circuit design flow.**

JoQED (*Josephson QED*, pronounced "Jo-Q-E-D") is an early-stage design-automation
project for superconducting quantum chips and their control circuitry: formulate
physical targets (frequencies, χ, κ, T1, capacitances), simulate, and iteratively
optimize the chip geometry until the targets converge.

## Status

Pre-alpha. This repository currently holds the reference design flows and tooling
groundwork; the software itself is under construction.

## Design flows

Two reference flows, documented as flow charts in [docs/design-flow](docs/design-flow):

| Flow | Chart | Stack |
|---|---|---|
| Commercial | [design_flow_hfss.pdf](docs/design-flow/design_flow_hfss.pdf) | Qiskit Metal → Ansys HFSS (eigenmode / capacitance) → pyEPR → optimizer |
| Open source | [design_flow_opensource.pdf](docs/design-flow/design_flow_opensource.pdf) | Qiskit Metal → Gmsh → Palace (eigenmode / electrostatic) → EPR analysis → optimizer |

The open-source flow runs identically on macOS and Linux; on Windows, Palace runs
via WSL2 or Docker. The charts are generated by the `build_flow_*.py` scripts in
the same directory (requires `reportlab`).

## Tooling

- [tools/build_palace.sh](tools/build_palace.sh) — builds
  [Palace](https://github.com/awslabs/palace) (AWS's open-source FEM solver for
  electromagnetics) from source into `tools/palace/`, using Homebrew-provided
  CMake, Open MPI, gfortran, and OpenBLAS on macOS. Expect a 30–60 minute compile.

## Open-source stack

| Role | Tool | License |
|---|---|---|
| Chip layout | [Qiskit Metal](https://github.com/qiskit-community/qiskit-metal) (`quantum-metal` fork) | Apache-2.0 |
| Meshing | [Gmsh](https://gmsh.info) | GPL |
| FEM simulation (eigenmode, electrostatic) | [Palace](https://github.com/awslabs/palace) | Apache-2.0 |
| Metal → Palace bridge | [SQDMetal](https://github.com/sqdlab/SQDMetal) | BSD-3 |
| Quantum analysis | [scqubits](https://github.com/scqubits/scqubits), [QuTiP](https://qutip.org), [pyEPR](https://github.com/zlatko-minev/pyEPR) | BSD |
| Optimization | [QDesignOptimizer](https://github.com/202Q-lab/QDesignOptimizer) | Apache-2.0 |

## License

[Apache License 2.0](LICENSE)
