build based on 455d50f

previews/PR120/gettingstarted/index.html

@@ -22,4 +22,4 @@
 # output
 
 1×44100 Matrix{Float64}:
- 0.0  0.0275964  0.0990996  0.195777  …  -0.537508  -0.462978  -0.36521</code></pre><p>The output <code>y</code> now likewise is a matrix with one row for the one probe we have added to the circuit and one column per sample.</p><p>More interesting circuits can be found in the examples located at <code>Pkg.dir(&quot;ACME/examples&quot;)</code>.</p><p>In the likely event that you would like to process real audio data, take a look at the <a href="https://github.com/dancasimiro/WAV.jl">WAV</a> package for reading writing WAV files.</p><p>Note that the solver used to solve the non-linear equation when running the model saves solutions to use as starting points in the future. Model execution will therefore become faster after an initial learning phase.  Nevertheless, ACME is at present more geared towards computing all the model matrices than to actually running the model. More complex circuits may run intolerably slow or fail to run altogether.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../ug/">User Guide »</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.10 on <span class="colophon-date" title="Wednesday 15 May 2024 14:35">Wednesday 15 May 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+ 0.0  0.0275964  0.0990996  0.195777  …  -0.537508  -0.462978  -0.36521</code></pre><p>The output <code>y</code> now likewise is a matrix with one row for the one probe we have added to the circuit and one column per sample.</p><p>More interesting circuits can be found in the examples located at <code>Pkg.dir(&quot;ACME/examples&quot;)</code>.</p><p>In the likely event that you would like to process real audio data, take a look at the <a href="https://github.com/dancasimiro/WAV.jl">WAV</a> package for reading writing WAV files.</p><p>Note that the solver used to solve the non-linear equation when running the model saves solutions to use as starting points in the future. Model execution will therefore become faster after an initial learning phase.  Nevertheless, ACME is at present more geared towards computing all the model matrices than to actually running the model. More complex circuits may run intolerably slow or fail to run altogether.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../ug/">User Guide »</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.10 on <span class="colophon-date" title="Wednesday 15 May 2024 14:50">Wednesday 15 May 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

previews/PR120/index.html

@@ -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>Home · ACME.jl</title><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.039/juliamono-regular.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.11/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" 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>ACME.jl</a></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 class="is-active"><a class="tocitem" href>Home</a></li><li><a class="tocitem" href="gettingstarted/">Getting Started</a></li><li><a class="tocitem" href="ug/">User Guide</a></li><li><a class="tocitem" href="elements/">Element Reference</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>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-edit-link" href="https://github.com/HSU-ANT/ACME.jl/blob/master/docs/src/index.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="ACME.jl-Analog-Circuit-Modeling-and-Emulation-for-Julia"><a class="docs-heading-anchor" href="#ACME.jl-Analog-Circuit-Modeling-and-Emulation-for-Julia">ACME.jl - Analog Circuit Modeling and Emulation for Julia</a><a id="ACME.jl-Analog-Circuit-Modeling-and-Emulation-for-Julia-1"></a><a class="docs-heading-anchor-permalink" href="#ACME.jl-Analog-Circuit-Modeling-and-Emulation-for-Julia" title="Permalink"></a></h1><p>ACME is a <a href="http://julialang.org/">Julia</a> package for the simulation of electrical circuits, focusing on audio effect circuits. It allows to programmatically describe a circuit in terms of elements and connections between them and then automatically derive a model for the circuit. The model can then be run on varying input data.</p><p>ACME is based on the method described in <a href="http://www.eurasip.org/Proceedings/Eusipco/Eusipco2015/papers/1570103545.pdf">M. Holters, U. Zölzer, &quot;A Generalized Method for the Derivation of Non-Linear State-Space Models from Circuit Schematics&quot;</a>.</p><ul><li><a href="gettingstarted/#Getting-Started">Getting Started</a></li><li class="no-marker"><ul><li><a href="gettingstarted/#Installation">Installation</a></li><li><a href="gettingstarted/#First-Steps">First Steps</a></li></ul></li><li><a href="ug/#User-Guide">User Guide</a></li><li class="no-marker"><ul><li><a href="ug/#Element-Creation">Element Creation</a></li><li><a href="ug/#Circuit-Description">Circuit Description</a></li><li><a href="ug/#Model-Creation-and-Use">Model Creation and Use</a></li><li><a href="ug/#Solvers">Solvers</a></li></ul></li><li><a href="elements/#Element-Reference">Element Reference</a></li><li class="no-marker"><ul><li><a href="elements/#Passives">Passives</a></li><li><a href="elements/#Independent-Sources">Independent Sources</a></li><li><a href="elements/#Probes">Probes</a></li><li><a href="elements/#Semiconductors">Semiconductors</a></li><li><a href="elements/#Integrated-Circuits">Integrated Circuits</a></li></ul></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="gettingstarted/">Getting Started »</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.10 on <span class="colophon-date" title="Wednesday 15 May 2024 14:35">Wednesday 15 May 2024</span>. Using Julia version 1.6.7.</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>Home · ACME.jl</title><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.039/juliamono-regular.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.11/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" 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>ACME.jl</a></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 class="is-active"><a class="tocitem" href>Home</a></li><li><a class="tocitem" href="gettingstarted/">Getting Started</a></li><li><a class="tocitem" href="ug/">User Guide</a></li><li><a class="tocitem" href="elements/">Element Reference</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>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-edit-link" href="https://github.com/HSU-ANT/ACME.jl/blob/master/docs/src/index.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="ACME.jl-Analog-Circuit-Modeling-and-Emulation-for-Julia"><a class="docs-heading-anchor" href="#ACME.jl-Analog-Circuit-Modeling-and-Emulation-for-Julia">ACME.jl - Analog Circuit Modeling and Emulation for Julia</a><a id="ACME.jl-Analog-Circuit-Modeling-and-Emulation-for-Julia-1"></a><a class="docs-heading-anchor-permalink" href="#ACME.jl-Analog-Circuit-Modeling-and-Emulation-for-Julia" title="Permalink"></a></h1><p>ACME is a <a href="http://julialang.org/">Julia</a> package for the simulation of electrical circuits, focusing on audio effect circuits. It allows to programmatically describe a circuit in terms of elements and connections between them and then automatically derive a model for the circuit. The model can then be run on varying input data.</p><p>ACME is based on the method described in <a href="http://www.eurasip.org/Proceedings/Eusipco/Eusipco2015/papers/1570103545.pdf">M. Holters, U. Zölzer, &quot;A Generalized Method for the Derivation of Non-Linear State-Space Models from Circuit Schematics&quot;</a>.</p><ul><li><a href="gettingstarted/#Getting-Started">Getting Started</a></li><li class="no-marker"><ul><li><a href="gettingstarted/#Installation">Installation</a></li><li><a href="gettingstarted/#First-Steps">First Steps</a></li></ul></li><li><a href="ug/#User-Guide">User Guide</a></li><li class="no-marker"><ul><li><a href="ug/#Element-Creation">Element Creation</a></li><li><a href="ug/#Circuit-Description">Circuit Description</a></li><li><a href="ug/#Model-Creation-and-Use">Model Creation and Use</a></li><li><a href="ug/#Solvers">Solvers</a></li></ul></li><li><a href="elements/#Element-Reference">Element Reference</a></li><li class="no-marker"><ul><li><a href="elements/#Passives">Passives</a></li><li><a href="elements/#Independent-Sources">Independent Sources</a></li><li><a href="elements/#Probes">Probes</a></li><li><a href="elements/#Semiconductors">Semiconductors</a></li><li><a href="elements/#Integrated-Circuits">Integrated Circuits</a></li></ul></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="gettingstarted/">Getting Started »</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.10 on <span class="colophon-date" title="Wednesday 15 May 2024 14:50">Wednesday 15 May 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>