build based on 323f795

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-03-28T18:30:53","documenter_version":"1.3.0"}}
+{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-03-28T18:47:03","documenter_version":"1.3.0"}}

dev/index.html

@@ -42,4 +42,4 @@
  </a>
  <code>PoschlTeller</code>
  </div> -->
-</div><h2 id="Future-Works"><a class="docs-heading-anchor" href="#Future-Works">Future Works</a><a id="Future-Works-1"></a><a class="docs-heading-anchor-permalink" href="#Future-Works" title="Permalink"></a></h2><p><a href="https://en.wikipedia.org/wiki/List_of_quantum-mechanical_systems_with_analytical_solutions">List of quantum-mechanical systems with analytical solutions</a></p><h2 id="Developer&#39;s-Guide"><a class="docs-heading-anchor" href="#Developer&#39;s-Guide">Developer&#39;s Guide</a><a id="Developer&#39;s-Guide-1"></a><a class="docs-heading-anchor-permalink" href="#Developer&#39;s-Guide" title="Permalink"></a></h2><p>This is the guideline for adding new models.</p><ol><li>First, please add a new issue <a href="https://github.com/ohno/Antique.jl/issues">here</a>. We need to find a reference for the definition and analytical solutions (eigenvalues and eigenfunctions) before the development.</li><li>Fork <a href="https://github.com/ohno/Antique.jl">the repository</a> on GitHub.</li><li>Clone the forked repository to your local machine by Git.</li><li>Add the new model name <code>:ModelName</code> to the <code>models = [...]</code> array in src/Antique.jl. <code>:</code> is required at the beginning.</li><li>Add the file src/ModelName.jl with the same name as the model name. The most helpful code examples are harmonic oscillators for one-dimensional systems and hydrogen atoms for three-dimensional systems. We recommend that you copy these.</li><li>Write the code in that file. First we need to create a structure <code>struct ModelName</code> with the same name as the model name (The best way is Find &amp; Replace). Create V, E, ψ and other functions. Because the function names conflict, you must always give the structure as an argument. Multi-dispatch avoids conflict. We recommend using Revice.jl while coding. Run <code>include(&quot;./developer/revice.jl&quot;)</code> on the REPL or use dev.ipynb.</li><li>Add test code test/ModelName.jl. At a minimum, it is recommended to check the normalization and the orthogonality of wavefunction using QuadGK.jl. All tests will be executed by executing <code>include(&quot;./developer/test.jl&quot;)</code>. It will take about 2 minutes to complete.</li><li>Add documentation. Add either docs/ModelName.md or docs/jmd/ModelName.jmd (if you have a jmd file, the md file will be automatically generated). Include at least the definition of the Hamiltonian and the analytical solutions (eigenvalues and eigenfunctions).</li><li>Add the new model into <code>pages=[...]</code> in docs/make.jl.</li><li>Execute <code>include(&quot;./developer/docs.jl&quot;)</code> to compile. Please check docs/build/*.html in your browser.</li><li>Push the code.</li><li>Submit a pull request on GitHub.</li></ol><h2 id="Acknowledgment"><a class="docs-heading-anchor" href="#Acknowledgment">Acknowledgment</a><a id="Acknowledgment-1"></a><a class="docs-heading-anchor-permalink" href="#Acknowledgment" title="Permalink"></a></h2><p>This package was named by <a href="https://github.com/KB-satou">@KB-satou</a> and <a href="https://github.com/ultimatile">@ultimatile</a>.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="InfinitePotentialWell/">Infinite Potential Well »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Thursday 28 March 2024 18:30">Thursday 28 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+</div><h2 id="Future-Works"><a class="docs-heading-anchor" href="#Future-Works">Future Works</a><a id="Future-Works-1"></a><a class="docs-heading-anchor-permalink" href="#Future-Works" title="Permalink"></a></h2><p><a href="https://en.wikipedia.org/wiki/List_of_quantum-mechanical_systems_with_analytical_solutions">List of quantum-mechanical systems with analytical solutions</a></p><h2 id="Developer&#39;s-Guide"><a class="docs-heading-anchor" href="#Developer&#39;s-Guide">Developer&#39;s Guide</a><a id="Developer&#39;s-Guide-1"></a><a class="docs-heading-anchor-permalink" href="#Developer&#39;s-Guide" title="Permalink"></a></h2><p>This is the guideline for adding new models.</p><ol><li>First, please add a new issue <a href="https://github.com/ohno/Antique.jl/issues">here</a>. We need to find a reference for the definition and analytical solutions (eigenvalues and eigenfunctions) before the development.</li><li>Fork <a href="https://github.com/ohno/Antique.jl">the repository</a> on GitHub.</li><li>Clone the forked repository to your local machine by Git.</li><li>Add the new model name <code>:ModelName</code> to the <code>models = [...]</code> array in src/Antique.jl. <code>:</code> is required at the beginning.</li><li>Add the file src/ModelName.jl with the same name as the model name. The most helpful code examples are harmonic oscillators for one-dimensional systems and hydrogen atoms for three-dimensional systems. We recommend that you copy these.</li><li>Write the code in that file. First we need to create a structure <code>struct ModelName</code> with the same name as the model name (The best way is Find &amp; Replace). Create V, E, ψ and other functions. Because the function names conflict, you must always give the structure as an argument. Multi-dispatch avoids conflict. We recommend using Revice.jl while coding. Run <code>include(&quot;./developer/revice.jl&quot;)</code> on the REPL or use dev.ipynb.</li><li>Add test code test/ModelName.jl. At a minimum, it is recommended to check the normalization and the orthogonality of wavefunction using QuadGK.jl. All tests will be executed by executing <code>include(&quot;./developer/test.jl&quot;)</code>. It will take about 2 minutes to complete.</li><li>Add documentation. Add either docs/ModelName.md or docs/jmd/ModelName.jmd (if you have a jmd file, the md file will be automatically generated). Include at least the definition of the Hamiltonian and the analytical solutions (eigenvalues and eigenfunctions).</li><li>Add the new model into <code>pages=[...]</code> in docs/make.jl.</li><li>Execute <code>include(&quot;./developer/docs.jl&quot;)</code> to compile. Please check docs/build/*.html in your browser.</li><li>Push the code.</li><li>Submit a pull request on GitHub.</li></ol><h2 id="Acknowledgment"><a class="docs-heading-anchor" href="#Acknowledgment">Acknowledgment</a><a id="Acknowledgment-1"></a><a class="docs-heading-anchor-permalink" href="#Acknowledgment" title="Permalink"></a></h2><p>This package was named by <a href="https://github.com/KB-satou">@KB-satou</a> and <a href="https://github.com/ultimatile">@ultimatile</a>.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="InfinitePotentialWell/">Infinite Potential Well »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Thursday 28 March 2024 18:47">Thursday 28 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>