qojulia / qojulia/QuantumInputOutput.jl
Add high-level constructors for common SLH components
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 7
- Forks
- 0
- Avg merge
- 7h 15m
- Merged PRs (30d)
- 26
Description
The theory docs list common SLH elements such as phase shifters, beamsplitters, coherent drives, one-sided cavities, two-sided cavities, and waveguide-coupled emitters. At the moment, users need to manually write them each time.
Adding named constructors could make this convenient.
Possible constructors:
phase_shifter(ϕ)
beamsplitter(r, t)
coherent_drive(α)
one_sided_cavity(a; κ, Δ=0)
two_sided_cavity(a; κ1, κ2, Δ=0)
waveguide_tls(σ; γR, γL=0, Δ=0)Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the theory documentation and the existing manual definitions of SLH elements. Determine the intended behavior for the proposed phase_shifter, beamsplitter, coherent_drive, cavity, and waveguide_tls constructors, then verify that each common component can be created through its named constructor.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- api
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100