Skip to content

Commit

Permalink
build based on 73156d8
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Oct 13, 2023
1 parent 1ce2589 commit ba9c483
Show file tree
Hide file tree
Showing 8 changed files with 65 additions and 50 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-10-11T19:52:17","documenter_version":"1.1.0"}}
{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-10-13T13:50:42","documenter_version":"1.1.1"}}
85 changes: 50 additions & 35 deletions dev/assets/documenter.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dev/assets/themes/documenter-dark.css
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/assets/themes/documenter-light.css
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file modified dev/example.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions dev/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · InverseLangevinApproximations.jl</title><meta name="title" content="Home · InverseLangevinApproximations.jl"/><meta property="og:title" content="Home · InverseLangevinApproximations.jl"/><meta property="twitter:title" content="Home · InverseLangevinApproximations.jl"/><meta name="description" content="Documentation for InverseLangevinApproximations.jl."/><meta property="og:description" content="Documentation for InverseLangevinApproximations.jl."/><meta property="twitter:description" content="Documentation for InverseLangevinApproximations.jl."/><meta property="og:url" content="https://TRACER-LULab.github.io/InverseLangevinApproximations.jl/"/><meta property="twitter:url" content="https://TRACER-LULab.github.io/InverseLangevinApproximations.jl/"/><link rel="canonical" href="https://TRACER-LULab.github.io/InverseLangevinApproximations.jl/"/><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="search_index.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href>InverseLangevinApproximations.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a></li><li><a class="tocitem" href="methods/">Approximations</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/TRACER-LULab/InverseLangevinApproximations.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/TRACER-LULab/InverseLangevinApproximations.jl/blob/main/docs/src/index.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="InverseLangevinApproximations"><a class="docs-heading-anchor" href="#InverseLangevinApproximations">InverseLangevinApproximations</a><a id="InverseLangevinApproximations-1"></a><a class="docs-heading-anchor-permalink" href="#InverseLangevinApproximations" title="Permalink"></a></h1><p>A Julia package for approximating the inverse of the Langevin function, ℒ.</p><p class="math-container">\[\mathcal{L}(x) = \coth(x) - \frac{1}{x}\]</p><pre><code class="language-julia hljs">using CairoMakie
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · InverseLangevinApproximations.jl</title><meta name="title" content="Home · InverseLangevinApproximations.jl"/><meta property="og:title" content="Home · InverseLangevinApproximations.jl"/><meta property="twitter:title" content="Home · InverseLangevinApproximations.jl"/><meta name="description" content="Documentation for InverseLangevinApproximations.jl."/><meta property="og:description" content="Documentation for InverseLangevinApproximations.jl."/><meta property="twitter:description" content="Documentation for InverseLangevinApproximations.jl."/><meta property="og:url" content="https://TRACER-LULab.github.io/InverseLangevinApproximations.jl/"/><meta property="twitter:url" content="https://TRACER-LULab.github.io/InverseLangevinApproximations.jl/"/><link rel="canonical" href="https://TRACER-LULab.github.io/InverseLangevinApproximations.jl/"/><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="search_index.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href>InverseLangevinApproximations.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a></li><li><a class="tocitem" href="methods/">API</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/TRACER-LULab/InverseLangevinApproximations.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/TRACER-LULab/InverseLangevinApproximations.jl/blob/main/docs/src/index.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="InverseLangevinApproximations"><a class="docs-heading-anchor" href="#InverseLangevinApproximations">InverseLangevinApproximations</a><a id="InverseLangevinApproximations-1"></a><a class="docs-heading-anchor-permalink" href="#InverseLangevinApproximations" title="Permalink"></a></h1><p>A Julia package for approximating the inverse of the Langevin function, ℒ.</p><p class="math-container">\[\mathcal{L}(x) = \coth(x) - \frac{1}{x}\]</p><pre><code class="language-julia hljs">using CairoMakie
using InteractiveUtils
using InverseLangevinApproximations
L(x) = x==zero(x) ? 0 : coth(x) - 1/x
x_true = range(0.0, 10.0, length = 101)
y = L.(x_true)
use_model(x) = Base.isexported(InverseLangevinApproximations, Symbol(x))
fs = filter(use_model, subtypes(InverseLangevinApproximations.AbstractInverseLangevinApproximation))
f = Figure(resolution = (1000, 1000))
f = Figure(resolution = (750, 750))
ax = Axis(f[1, 1], xlabel = &quot;y&quot;, ylabel = &quot;Relative Error&quot;, xticks = 0:0.2:1.0)
for f in fs
x = inverse_langevin_approximation.(f(), y)
x = inverse_langevin_approximation.(y, f())
rel_error = abs.((x .- x_true) ./ x_true)
lines!(ax, y, rel_error, label = string(f))
end
axislegend(position = :lt)</code></pre><div class="markdown"><p><img src="example.png" alt="example" /></p>
</div></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="methods/">Approximations »</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.0 on <span class="colophon-date" title="Wednesday 11 October 2023 19:52">Wednesday 11 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
</div></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="methods/">API »</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.1 on <span class="colophon-date" title="Friday 13 October 2023 13:50">Friday 13 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit ba9c483

Please sign in to comment.