kestrelquantum / QuantumCollocation.jl

Quantum Optimal Control with Direct Collocation
MIT License
29 stars 7 forks source link

Adding Flowchart to Index.md #108

Open Fe-r-oz opened 4 months ago

Fe-r-oz commented 4 months ago

PR #108 w.r.t Issue 94

Fe-r-oz commented 3 months ago

Hi, @aarontrowbridge and @andgoldschmidt

How about this one instead of the one I presented before? No colors involved this time.

%%{ init: {'theme': 'base', 'themeVariables': { 'primaryColor': '#FFFFFF', 'primaryTextColor': '#000000', 'edgeLabelBackground': '#FFFFFF', 'tertiaryColor': '#000000' }} }%%

graph TD
    subgraph QuantumCollocations.jl
        A["<code>QuantumCollocations.jl</code>"]

        subgraph Integrators
            B["<code>UnitaryPadeIntegrator</code>"]
        end

        subgraph QuantumSystems
            C["<code>G</code>"]
            D["<code>AbstractQuantumSystem</code>"]
            E["<code>QuantumSystem</code>"]
            F["<code>QuantumSystemCoupling</code>"]
            G["<code>H</code>"]
        end

        subgraph ProblemTemplate
            H["<code>UnitaryMinimumTimeProblem</code>"]
            I["<code>UnitarySmoothPulseProblem</code>"]
        end

        subgraph QuantumUtils
            J["<code>annihilate</code>"]
            K["<code>create</code>"]
            L["<code>kron_from_dict</code>"]
            M["<code>operator_from_dict</code>"]
            N["<code>quad</code>"]
            O["<code>number</code>"]
            P["<code>quantum_state</code>"]
            Q["<code>vec^-1</code>"]
        end

        subgraph Losses
            S["<code>unitary_fidelity</code>"]
            R["<code>isovec_unitary_fidelity</code>"]
        end
    end
    A --> Integrators
    A --> QuantumSystems
    A --> ProblemTemplate
    A --> QuantumUtils
    A --> Losses

classDef default fill:#FFFFFF,stroke:#000000,stroke-width:2px,color:#000000;