build based on 553c890

dev/examples/index.html

@@ -50,4 +50,4 @@
 Hellwarth (61) Omega (freq): 500.08501275972833</code></pre><h2 id="Temperature-dependent-behaviour"><a class="docs-heading-anchor" href="#Temperature-dependent-behaviour">Temperature-dependent behaviour</a><a id="Temperature-dependent-behaviour-1"></a><a class="docs-heading-anchor-permalink" href="#Temperature-dependent-behaviour" title="Permalink"></a></h2><p>Getting temperature-dependent behaviour is a matter of sending a temperature range to the <code>polaronmobility</code> function.</p><pre><code class="language-julia hljs">MAPIe=polaronmobility(10:10:1000, 4.5, 24.1, 2.25, 0.12)</code></pre><h2 id="Plotting"><a class="docs-heading-anchor" href="#Plotting">Plotting</a><a id="Plotting-1"></a><a class="docs-heading-anchor-permalink" href="#Plotting" title="Permalink"></a></h2><p>For publication, <code>savepolaron</code> outputs a column-delimited text file for post-production plotting (with gnuplot) or similar.</p><pre><code class="language-julia hljs">savepolaron(&quot;MAPI-electron&quot;,MAPIe)</code></pre><p>Example <code>gnuplot</code> scripts can be found in <a href="https://github.com/jarvist/PolaronMobility.jl/tree/master/examples/">Examples</a> and <a href="http://github.com/jarvist/PolaronMobility.jl/tree/master/HalidePerovskites/">HalidePerovskites</a>.</p><h2 id="Built-in-plotting"><a class="docs-heading-anchor" href="#Built-in-plotting">Built in plotting</a><a id="Built-in-plotting-1"></a><a class="docs-heading-anchor-permalink" href="#Built-in-plotting" title="Permalink"></a></h2><p>The convenience function <code>plotpolaron</code> generates (and saves) a number of <code>Plots.jl</code> figures of the temperature dependent behaviour.</p><p>It has been separated off into its own submodule (<code>PlotPolaron</code>), so that the <code>Plots.jl</code> dependency does not slow down loading of <code>PolaronMobility.jl</code>.</p><p>To use it, we therefore need to inform Julia where to find PlotPolaron. A suitable initialisation script was kindly supplied by @wkearn:</p><pre><code class="language-julia hljs">using PolaronMobility, Plots
 gr()
 include(Pkg.dir(&quot;PolaronMobility&quot;,&quot;src&quot;,&quot;PlotPolaron.jl&quot;))
-using PlotPolaron</code></pre><p>As with savepolaron, the call signature is output-file-string and then the polaron object which you have calculated.</p><pre><code class="language-julia hljs">plotpolaron(&quot;MAPI-electron&quot;,MAPIe)</code></pre><p>This will attempt to make fairly sensible defaults, and plot a lot of different data of sufficient quality for talk slides.</p><p>Much for the functionality has been unrolled into the <a href="https://github.com/jarvist/PolaronMobility.jl/blob/master/JuliaBox-Example.ipynb">Jupyter Notebook example</a>, which should also be interactively-runnable from (https://juliabox.com). See the repository <a href="https://github.com/jarvist/PolaronMobility.jl/blob/master/README.md#juliabox">README.md</a> for the latest information.</p><p>Here is a figure showing typical temperature-dependent behaviour of the three-different polaron mobility approximations, for MAPI.</p><p><img src="../assets/MAPI-mobility.png" alt="MAPI mobility"/></p><h2 id="Further-examples"><a class="docs-heading-anchor" href="#Further-examples">Further examples</a><a id="Further-examples-1"></a><a class="docs-heading-anchor-permalink" href="#Further-examples" title="Permalink"></a></h2><p>More complete examples are provided in  <a href="https://github.com/jarvist/PolaronMobility.jl/tree/master/examples/">Examples</a> and <a href="http://github.com/jarvist/PolaronMobility.jl/tree/master/HalidePerovskites/">HalidePerovskites</a>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« PolaronMobility.jl</a><a class="docs-footer-nextpage" href="../functions/">Functions »</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="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 0.27.25 on <span class="colophon-date" title="Friday 6 October 2023 23:14">Friday 6 October 2023</span>. Using Julia version 1.7.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+using PlotPolaron</code></pre><p>As with savepolaron, the call signature is output-file-string and then the polaron object which you have calculated.</p><pre><code class="language-julia hljs">plotpolaron(&quot;MAPI-electron&quot;,MAPIe)</code></pre><p>This will attempt to make fairly sensible defaults, and plot a lot of different data of sufficient quality for talk slides.</p><p>Much for the functionality has been unrolled into the <a href="https://github.com/jarvist/PolaronMobility.jl/blob/master/JuliaBox-Example.ipynb">Jupyter Notebook example</a>, which should also be interactively-runnable from (https://juliabox.com). See the repository <a href="https://github.com/jarvist/PolaronMobility.jl/blob/master/README.md#juliabox">README.md</a> for the latest information.</p><p>Here is a figure showing typical temperature-dependent behaviour of the three-different polaron mobility approximations, for MAPI.</p><p><img src="../assets/MAPI-mobility.png" alt="MAPI mobility"/></p><h2 id="Further-examples"><a class="docs-heading-anchor" href="#Further-examples">Further examples</a><a id="Further-examples-1"></a><a class="docs-heading-anchor-permalink" href="#Further-examples" title="Permalink"></a></h2><p>More complete examples are provided in  <a href="https://github.com/jarvist/PolaronMobility.jl/tree/master/examples/">Examples</a> and <a href="http://github.com/jarvist/PolaronMobility.jl/tree/master/HalidePerovskites/">HalidePerovskites</a>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« PolaronMobility.jl</a><a class="docs-footer-nextpage" href="../functions/">Functions »</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="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 0.27.25 on <span class="colophon-date" title="Tuesday 10 October 2023 15:51">Tuesday 10 October 2023</span>. Using Julia version 1.7.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/index.html

@@ -10,4 +10,4 @@
   author = {Jarvist Moore Frost},
   title = {Calculating polaron mobility in halide perovskites},
   journal = {Physical Review B}
-}</code></pre></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="examples/">Examples »</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="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 0.27.25 on <span class="colophon-date" title="Friday 6 October 2023 23:14">Friday 6 October 2023</span>. Using Julia version 1.7.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+}</code></pre></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="examples/">Examples »</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="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 0.27.25 on <span class="colophon-date" title="Tuesday 10 October 2023 15:51">Tuesday 10 October 2023</span>. Using Julia version 1.7.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/scientific_discussion/index.html

@@ -136,4 +136,4 @@
   title = {Velocity Acquired by an Electron in a Finite Electric Field in a Polar Crystal},
   journal = {Physical Review B}
 }
-</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../functions/">« Functions</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="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 0.27.25 on <span class="colophon-date" title="Friday 6 October 2023 23:14">Friday 6 October 2023</span>. Using Julia version 1.7.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../functions/">« Functions</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="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 0.27.25 on <span class="colophon-date" title="Tuesday 10 October 2023 15:51">Tuesday 10 October 2023</span>. Using Julia version 1.7.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>