Skip to content

Commit

Permalink
added workflow for building docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@abhirup-m
abhirup-m committed Jul 28, 2024
1 parent 8d05b7a commit c550202
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion docs/build/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-28T19:29:33","documenter_version":"1.5.0"}}
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-28T22:15:51","documenter_version":"1.5.0"}}
12 changes: 6 additions & 6 deletions docs/build/base/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@
julia> BasisStates(4, [2], [0], x->sum(x[1:2])==1)
2-element Vector{Dict{BitVector, Float64}}:
Dict([0, 1, 1, 0] => 1.0)
Dict([1, 0, 0, 1] =&gt; 1.0)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/abhirup-m/fermions.jl/blob/702bb64139b45e89aaf3292e5184b21ae4d04cee/src/base.jl#L21-L46">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="fermions.TransformBit-Tuple{Bool, Char}" href="#fermions.TransformBit-Tuple{Bool, Char}"><code>fermions.TransformBit</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">TransformBit(qubit, operator)</code></pre><p>Apply the single qubit operator (&#39;n&#39;, &#39;h&#39;, &#39;+&#39; or &#39;-&#39;) on a single fock state.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; TransformBit(Bool(0), &#39;+&#39;)
Dict([1, 0, 0, 1] =&gt; 1.0)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/abhirup-m/fermions.jl/blob/8d05b7a65d8e868370f00d0a3d683d47625f6f33/src/base.jl#L1-L26">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="fermions.TransformBit-Tuple{Bool, Char}" href="#fermions.TransformBit-Tuple{Bool, Char}"><code>fermions.TransformBit</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">TransformBit(qubit, operator)</code></pre><p>Apply the single qubit operator (&#39;n&#39;, &#39;h&#39;, &#39;+&#39; or &#39;-&#39;) on a single fock state.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; TransformBit(Bool(0), &#39;+&#39;)
(1, 1)

julia&gt; TransformBit(Bool(1), &#39;h&#39;)
(1, 0)

julia&gt; TransformBit(Bool(1), &#39;-&#39;)
(0, 1)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/abhirup-m/fermions.jl/blob/702bb64139b45e89aaf3292e5184b21ae4d04cee/src/base.jl#L126-L142">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="fermions.ApplyOperatorChunk-Tuple{String, Vector{Int64}, Float64, Dict{BitVector, Float64}}" href="#fermions.ApplyOperatorChunk-Tuple{String, Vector{Int64}, Float64, Dict{BitVector, Float64}}"><code>fermions.ApplyOperatorChunk</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">ApplyOperatorChunk(opType, opMembers, opStrength, incomingState; tolerance)</code></pre><p>Apply a single tensor product operator chunk (for eg., c^†<em>1 c</em>2 or n<em>1 c^†</em>3 c_4) on a general state and return the new state.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; state = Dict(Bool.([1, 0]) =&gt; 1.0, Bool.([0, 1]) =&gt; -0.5)
(0, 1)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/abhirup-m/fermions.jl/blob/8d05b7a65d8e868370f00d0a3d683d47625f6f33/src/base.jl#L106-L122">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="fermions.ApplyOperatorChunk-Tuple{String, Vector{Int64}, Float64, Dict{BitVector, Float64}}" href="#fermions.ApplyOperatorChunk-Tuple{String, Vector{Int64}, Float64, Dict{BitVector, Float64}}"><code>fermions.ApplyOperatorChunk</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">ApplyOperatorChunk(opType, opMembers, opStrength, incomingState; tolerance)</code></pre><p>Apply a single tensor product operator chunk (for eg., c^†<em>1 c</em>2 or n<em>1 c^†</em>3 c_4) on a general state and return the new state.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; state = Dict(Bool.([1, 0]) =&gt; 1.0, Bool.([0, 1]) =&gt; -0.5)
Dict{BitVector, Float64} with 2 entries:
[1, 0] =&gt; 1.0
[0, 1] =&gt; -0.5
Expand All @@ -30,7 +30,7 @@

julia&gt; ApplyOperatorChunk(opType, opMembers, opStrength, state)
Dict{BitVector, Float64} with 1 entry:
[1, 0] =&gt; -0.05</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/abhirup-m/fermions.jl/blob/702bb64139b45e89aaf3292e5184b21ae4d04cee/src/base.jl#L158-L178">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="fermions.ApplyOperator-Tuple{Vector{Tuple{String, Vector{Int64}, Float64}}, Dict{BitVector, Float64}}" href="#fermions.ApplyOperator-Tuple{Vector{Tuple{String, Vector{Int64}, Float64}}, Dict{BitVector, Float64}}"><code>fermions.ApplyOperator</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">ApplyOperator(operator, incomingState; tolerance)</code></pre><p>Extends ApplyOperatorChunk() by applying a more general operator (consisting of multiple operator chunks) on a general state.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; state = Dict(Bool.([1, 0]) =&gt; 1.0, Bool.([0, 1]) =&gt; -0.5)
[1, 0] =&gt; -0.05</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/abhirup-m/fermions.jl/blob/8d05b7a65d8e868370f00d0a3d683d47625f6f33/src/base.jl#L138-L158">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="fermions.ApplyOperator-Tuple{Vector{Tuple{String, Vector{Int64}, Float64}}, Dict{BitVector, Float64}}" href="#fermions.ApplyOperator-Tuple{Vector{Tuple{String, Vector{Int64}, Float64}}, Dict{BitVector, Float64}}"><code>fermions.ApplyOperator</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">ApplyOperator(operator, incomingState; tolerance)</code></pre><p>Extends ApplyOperatorChunk() by applying a more general operator (consisting of multiple operator chunks) on a general state.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; state = Dict(Bool.([1, 0]) =&gt; 1.0, Bool.([0, 1]) =&gt; -0.5)
Dict{BitVector, Float64} with 2 entries:
[1, 0] =&gt; 1.0
[0, 1] =&gt; -0.5
Expand All @@ -43,7 +43,7 @@
julia&gt; ApplyOperator(operator, state)
Dict{BitVector, Float64} with 2 entries:
[1, 0] =&gt; -0.05
[0, 1] =&gt; -0.5</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/abhirup-m/fermions.jl/blob/702bb64139b45e89aaf3292e5184b21ae4d04cee/src/base.jl#L230-L253">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="fermions.OperatorMatrix-Tuple{Vector{Dict{BitVector, Float64}}, Vector{Tuple{String, Vector{Int64}, Float64}}}" href="#fermions.OperatorMatrix-Tuple{Vector{Dict{BitVector, Float64}}, Vector{Tuple{String, Vector{Int64}, Float64}}}"><code>fermions.OperatorMatrix</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">OperatorMatrix(basisStates, operator)</code></pre><p>Return the matrix representation of the operator in the given basis.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; basis = BasisStates(2)
[0, 1] =&gt; -0.5</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/abhirup-m/fermions.jl/blob/8d05b7a65d8e868370f00d0a3d683d47625f6f33/src/base.jl#L210-L233">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="fermions.OperatorMatrix-Tuple{Vector{Dict{BitVector, Float64}}, Vector{Tuple{String, Vector{Int64}, Float64}}}" href="#fermions.OperatorMatrix-Tuple{Vector{Dict{BitVector, Float64}}, Vector{Tuple{String, Vector{Int64}, Float64}}}"><code>fermions.OperatorMatrix</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">OperatorMatrix(basisStates, operator)</code></pre><p>Return the matrix representation of the operator in the given basis.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; basis = BasisStates(2)
4-element Vector{Dict{BitVector, Float64}}:
Dict([0, 0] =&gt; 1.0)
Dict([0, 1] =&gt; 1.0)
Expand All @@ -60,7 +60,7 @@
0.0 0.0 0.0 0.0
0.0 -1.0 0.0 0.0
0.0 0.5 0.0 0.0
0.0 0.0 0.0 -1.0</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/abhirup-m/fermions.jl/blob/702bb64139b45e89aaf3292e5184b21ae4d04cee/src/base.jl#L270-L296">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="fermions.StateOverlap-Tuple{Dict{BitVector, Float64}, Dict{BitVector, Float64}}" href="#fermions.StateOverlap-Tuple{Dict{BitVector, Float64}, Dict{BitVector, Float64}}"><code>fermions.StateOverlap</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">StateOverlap(state1, state2)</code></pre><p>Compute the inner product ⟨state1|state2⟩.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; state1 = Dict(Bool.([1, 0]) =&gt; 1.0, Bool.([0, 1]) =&gt; -0.5)
0.0 0.0 0.0 -1.0</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/abhirup-m/fermions.jl/blob/8d05b7a65d8e868370f00d0a3d683d47625f6f33/src/base.jl#L250-L276">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="fermions.StateOverlap-Tuple{Dict{BitVector, Float64}, Dict{BitVector, Float64}}" href="#fermions.StateOverlap-Tuple{Dict{BitVector, Float64}, Dict{BitVector, Float64}}"><code>fermions.StateOverlap</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">StateOverlap(state1, state2)</code></pre><p>Compute the inner product ⟨state1|state2⟩.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; state1 = Dict(Bool.([1, 0]) =&gt; 1.0, Bool.([0, 1]) =&gt; -0.5)
Dict{BitVector, Float64} with 2 entries:
[1, 0] =&gt; 1.0
[0, 1] =&gt; -0.5
Expand All @@ -71,4 +71,4 @@
[0, 1] =&gt; 0.5

julia&gt; StateOverlap(state1, state2)
-0.25</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/abhirup-m/fermions.jl/blob/702bb64139b45e89aaf3292e5184b21ae4d04cee/src/base.jl#L315-L335">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Fermions.jl</a><a class="docs-footer-nextpage" href="../correlations/">Correlations - Computing Observables and Other Analyses »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Sunday 28 July 2024 19:29">Sunday 28 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
-0.25</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/abhirup-m/fermions.jl/blob/8d05b7a65d8e868370f00d0a3d683d47625f6f33/src/base.jl#L295-L315">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Fermions.jl</a><a class="docs-footer-nextpage" href="../correlations/">Correlations - Computing Observables and Other Analyses »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Sunday 28 July 2024 22:15">Sunday 28 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit c550202

Please sign in to comment.