Skip to content

Commit

Permalink
build based on 6c78364
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Oct 3, 2023
1 parent e9a9acf commit de65914
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion dev/api/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · </title><link rel="canonical" href="https://MagneticParticleImaging.github.io/MNPDynamics.jl/api/"/><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/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="../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"/><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"><a class="docs-logo" href="../"><img src="../assets/logo.png" alt=" logo"/></a><div class="docs-package-name"><span class="docs-autofit"> </span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../overview/">Overview</a></li><li class="is-active"><a class="tocitem" href>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"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/MagneticParticleImaging/MNPDynamics.jl/blob/master/docs/src/api.md#" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="API"><a class="docs-heading-anchor" href="#API">API</a><a id="API-1"></a><a class="docs-heading-anchor-permalink" href="#API" title="Permalink"></a></h1><p>In the following, you find the documentation of some, and hopefully soon all, exported functions of <a href="https://github.com/MagneticParticleImaging/MNPDynamics.jl">MNPDynamics.jl</a>:</p><ul><li><a href="#MNPDynamics.simulationMNP-Union{Tuple{T}, Tuple{Matrix{T}, Any}} where T"><code>MNPDynamics.simulationMNP</code></a></li><li><a href="#MNPDynamics.simulationMNP-Union{Tuple{g}, Tuple{g, Any}} where g"><code>MNPDynamics.simulationMNP</code></a></li><li><a href="#MNPDynamics.simulationMNPMultiParams-Union{Tuple{P}, Tuple{G}, Tuple{G, Any, Vector{P}}} where {G, P}"><code>MNPDynamics.simulationMNPMultiParams</code></a></li><li><a href="#MNPDynamics.simulationMNPMultiParams-Union{Tuple{T}, Tuple{Array{T, 3}, Any}} where T"><code>MNPDynamics.simulationMNPMultiParams</code></a></li></ul><article class="docstring"><header><a class="docstring-binding" id="MNPDynamics.simulationMNP-Union{Tuple{T}, Tuple{Matrix{T}, Any}} where T" href="#MNPDynamics.simulationMNP-Union{Tuple{T}, Tuple{Matrix{T}, Any}} where T"><code>MNPDynamics.simulationMNP</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia">simulationMNP(B::Matrix{T}, t; kargs...)</code></pre><p>This version takes the fields in discretized form</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MagneticParticleImaging/MNPDynamics.jl/blob/8b4661602033ad5750f4f2db36b42c8ade183c6d/src/simulation.jl#L296-L300">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="MNPDynamics.simulationMNP-Union{Tuple{g}, Tuple{g, Any}} where g" href="#MNPDynamics.simulationMNP-Union{Tuple{g}, Tuple{g, Any}} where g"><code>MNPDynamics.simulationMNP</code></a> — <span class="docstring-category">Method</span></header><section><div><p>simulationMNP(B, t, offsets; kargs...) </p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MagneticParticleImaging/MNPDynamics.jl/blob/8b4661602033ad5750f4f2db36b42c8ade183c6d/src/simulation.jl#L288-L290">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="MNPDynamics.simulationMNPMultiParams-Union{Tuple{P}, Tuple{G}, Tuple{G, Any, Vector{P}}} where {G, P}" href="#MNPDynamics.simulationMNPMultiParams-Union{Tuple{P}, Tuple{G}, Tuple{G, Any, Vector{P}}} where {G, P}"><code>MNPDynamics.simulationMNPMultiParams</code></a> — <span class="docstring-category">Method</span></header><section><div><p>simulationMNPMultiParams(B, t, params; kargs...) </p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MagneticParticleImaging/MNPDynamics.jl/blob/8b4661602033ad5750f4f2db36b42c8ade183c6d/src/multiParams.jl#L2-L4">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="MNPDynamics.simulationMNPMultiParams-Union{Tuple{T}, Tuple{Array{T, 3}, Any}} where T" href="#MNPDynamics.simulationMNPMultiParams-Union{Tuple{T}, Tuple{Array{T, 3}, Any}} where T"><code>MNPDynamics.simulationMNPMultiParams</code></a> — <span class="docstring-category">Method</span></header><section><div><p>simulationMNPMultiParams(B::Vector{Matrix{T}}, t; kargs...) </p><p>This version takes the fields in discretized form</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MagneticParticleImaging/MNPDynamics.jl/blob/8b4661602033ad5750f4f2db36b42c8ade183c6d/src/multiParams.jl#L82-L86">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../overview/">« Overview</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> on <span class="colophon-date" title="Saturday 30 September 2023 19:34">Saturday 30 September 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · </title><link rel="canonical" href="https://MagneticParticleImaging.github.io/MNPDynamics.jl/api/"/><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/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="../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"/><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"><a class="docs-logo" href="../"><img src="../assets/logo.png" alt=" logo"/></a><div class="docs-package-name"><span class="docs-autofit"> </span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../overview/">Overview</a></li><li class="is-active"><a class="tocitem" href>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"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/MagneticParticleImaging/MNPDynamics.jl/blob/master/docs/src/api.md#" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="API"><a class="docs-heading-anchor" href="#API">API</a><a id="API-1"></a><a class="docs-heading-anchor-permalink" href="#API" title="Permalink"></a></h1><p>In the following, you find the documentation of some, and hopefully soon all, exported functions of <a href="https://github.com/MagneticParticleImaging/MNPDynamics.jl">MNPDynamics.jl</a>:</p><ul><li><a href="#MNPDynamics.simulationMNP-Union{Tuple{g}, Tuple{g, Any}} where g"><code>MNPDynamics.simulationMNP</code></a></li><li><a href="#MNPDynamics.simulationMNP-Union{Tuple{T}, Tuple{Matrix{T}, Any}} where T"><code>MNPDynamics.simulationMNP</code></a></li><li><a href="#MNPDynamics.simulationMNPMultiParams-Union{Tuple{P}, Tuple{G}, Tuple{G, Any, Vector{P}}} where {G, P}"><code>MNPDynamics.simulationMNPMultiParams</code></a></li><li><a href="#MNPDynamics.simulationMNPMultiParams-Union{Tuple{T}, Tuple{Array{T, 3}, Any}} where T"><code>MNPDynamics.simulationMNPMultiParams</code></a></li></ul><article class="docstring"><header><a class="docstring-binding" id="MNPDynamics.simulationMNP-Union{Tuple{T}, Tuple{Matrix{T}, Any}} where T" href="#MNPDynamics.simulationMNP-Union{Tuple{T}, Tuple{Matrix{T}, Any}} where T"><code>MNPDynamics.simulationMNP</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia">simulationMNP(B::Matrix{T}, t; kargs...)</code></pre><p>This version takes the fields in discretized form</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MagneticParticleImaging/MNPDynamics.jl/blob/6c78364d5e04598d9400c1ad46bfae411dee9f47/src/simulation.jl#L296-L300">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="MNPDynamics.simulationMNP-Union{Tuple{g}, Tuple{g, Any}} where g" href="#MNPDynamics.simulationMNP-Union{Tuple{g}, Tuple{g, Any}} where g"><code>MNPDynamics.simulationMNP</code></a> — <span class="docstring-category">Method</span></header><section><div><p>simulationMNP(B, t, offsets; kargs...) </p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MagneticParticleImaging/MNPDynamics.jl/blob/6c78364d5e04598d9400c1ad46bfae411dee9f47/src/simulation.jl#L288-L290">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="MNPDynamics.simulationMNPMultiParams-Union{Tuple{P}, Tuple{G}, Tuple{G, Any, Vector{P}}} where {G, P}" href="#MNPDynamics.simulationMNPMultiParams-Union{Tuple{P}, Tuple{G}, Tuple{G, Any, Vector{P}}} where {G, P}"><code>MNPDynamics.simulationMNPMultiParams</code></a> — <span class="docstring-category">Method</span></header><section><div><p>simulationMNPMultiParams(B, t, params; kargs...) </p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MagneticParticleImaging/MNPDynamics.jl/blob/6c78364d5e04598d9400c1ad46bfae411dee9f47/src/multiParams.jl#L2-L4">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="MNPDynamics.simulationMNPMultiParams-Union{Tuple{T}, Tuple{Array{T, 3}, Any}} where T" href="#MNPDynamics.simulationMNPMultiParams-Union{Tuple{T}, Tuple{Array{T, 3}, Any}} where T"><code>MNPDynamics.simulationMNPMultiParams</code></a> — <span class="docstring-category">Method</span></header><section><div><p>simulationMNPMultiParams(B::Vector{Matrix{T}}, t; kargs...) </p><p>This version takes the fields in discretized form</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MagneticParticleImaging/MNPDynamics.jl/blob/6c78364d5e04598d9400c1ad46bfae411dee9f47/src/multiParams.jl#L82-L86">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../overview/">« Overview</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> on <span class="colophon-date" title="Tuesday 3 October 2023 10:23">Tuesday 3 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 de65914

Please sign in to comment.