-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Documenter.jl
committed
Aug 9, 2024
1 parent
7f5c5fd
commit 8cc409d
Showing
5 changed files
with
5 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| {"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-08-08T16:57:26","documenter_version":"1.5.0"}} | ||
| {"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-08-09T11:08:22","documenter_version":"1.5.0"}} |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · KitePodModels.jl</title><meta name="title" content="Home · KitePodModels.jl"/><meta property="og:title" content="Home · KitePodModels.jl"/><meta property="twitter:title" content="Home · KitePodModels.jl"/><meta name="description" content="Documentation for KitePodModels.jl."/><meta property="og:description" content="Documentation for KitePodModels.jl."/><meta property="twitter:description" content="Documentation for KitePodModels.jl."/><meta property="og:url" content="https://aenarete.github.io/KitePodModels.jl/"/><meta property="twitter:url" content="https://aenarete.github.io/KitePodModels.jl/"/><link rel="canonical" href="https://aenarete.github.io/KitePodModels.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/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><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"><a class="docs-logo" href><img src="assets/logo.png" alt="KitePodModels.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href>KitePodModels.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><ul class="internal"><li><a class="tocitem" href="#Background"><span>Background</span></a></li><li><a class="tocitem" href="#Installation"><span>Installation</span></a></li><li><a class="tocitem" href="#Testing"><span>Testing</span></a></li><li><a class="tocitem" href="#Provides"><span>Provides</span></a></li><li><a class="tocitem" href="#Step-response"><span>Step response</span></a></li><li><a class="tocitem" href="#Related"><span>Related</span></a></li></ul></li><li><a class="tocitem" href="types/">Types</a></li><li><a class="tocitem" href="functions/">Functions</a></li><li><a class="tocitem" href="parameters/">Parameters</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/aenarete/KitePodModels.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="KitePodModels"><a class="docs-heading-anchor" href="#KitePodModels">KitePodModels</a><a id="KitePodModels-1"></a><a class="docs-heading-anchor-permalink" href="#KitePodModels" title="Permalink"></a></h1><p>Documentation for <a href="https://github.com/aenarete/KitePodModels.jl">KitePodModels</a>.</p><h2 id="Background"><a class="docs-heading-anchor" href="#Background">Background</a><a id="Background-1"></a><a class="docs-heading-anchor-permalink" href="#Background" title="Permalink"></a></h2><p>A kite pod or kite control unit consists of one or two electric miniatur winches, that pull on two or three lines (attached to the kite) and allow to steer the kite and to change the angle of attack and thus the lift.</p><p>This software acts as controller: It has two inputs, the set values, and two outputs, the actual values.</p><p>Two P controllers are used. </p><p>The geometric nonlinearity due to the change of the effectiv drum diameter of the drum with the depower tape is taken into account.</p><h2 id="Installation"><a class="docs-heading-anchor" href="#Installation">Installation</a><a id="Installation-1"></a><a class="docs-heading-anchor-permalink" href="#Installation" title="Permalink"></a></h2><p>Download <a href="http://www.julialang.org">Julia 1.9</a> or later, if you haven't already. You can add KitePodModels from Julia's package manager, by typing </p><pre><code class="language-julia hljs">using Pkg | ||
| pkg"add KitePodModels"</code></pre><p>at the Julia prompt.</p><p>If you are using Windows, it is suggested to install git and bash, too. This is explained for example here: <a href="https://github.com/ufechner7/KiteViewer/blob/main/doc/Windows.md">Julia on Windows</a> .</p><h2 id="Testing"><a class="docs-heading-anchor" href="#Testing">Testing</a><a id="Testing-1"></a><a class="docs-heading-anchor-permalink" href="#Testing" title="Permalink"></a></h2><p>You can run the unit test suite with the following command:</p><pre><code class="language-julia hljs">pkg"test KitePodModels"</code></pre><h2 id="Provides"><a class="docs-heading-anchor" href="#Provides">Provides</a><a id="Provides-1"></a><a class="docs-heading-anchor-permalink" href="#Provides" title="Permalink"></a></h2><ul><li>functions to initialize the simulator, to update the set values and to read the actual values</li><li>a function on_timer() that needs to be called once per time step</li><li>a function to convert the actual depower value into change of angle of attack</li></ul><h2 id="Step-response"><a class="docs-heading-anchor" href="#Step-response">Step response</a><a id="Step-response-1"></a><a class="docs-heading-anchor-permalink" href="#Step-response" title="Permalink"></a></h2><p><img src="step_response.png" alt="Step Response"/></p><p>Click on <strong>Functions</strong> on the left to see the exported functions.</p><h2 id="Related"><a class="docs-heading-anchor" href="#Related">Related</a><a id="Related-1"></a><a class="docs-heading-anchor-permalink" href="#Related" title="Permalink"></a></h2><ul><li>The meta package <a href="https://github.com/aenarete/KiteSimulators.jl">KiteSimulators</a> which contains all packages from Julia Kite Power Tools.</li><li>the package <a href="https://github.com/ufechner7/KiteUtils.jl">KiteUtils</a></li><li>the packages <a href="https://github.com/ufechner7/KiteModels.jl">KiteModels</a> and <a href="https://github.com/aenarete/WinchModels.jl">WinchModels</a> and <a href="https://github.com/aenarete/AtmosphericModels.jl">AtmosphericModels</a></li><li>the packages <a href="https://github.com/aenarete/KiteControllers.jl">KiteControllers</a> and<a href="https://github.com/aenarete/KiteViewers.jl">KiteViewers</a></li></ul><p>Author: Uwe Fechner ([email protected])</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="types/">Types »</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><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Thursday 8 August 2024 16:57">Thursday 8 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> | ||
| pkg"add KitePodModels"</code></pre><p>at the Julia prompt.</p><p>If you are using Windows, it is suggested to install git and bash, too. This is explained for example here: <a href="https://github.com/ufechner7/KiteViewer/blob/main/doc/Windows.md">Julia on Windows</a> .</p><h2 id="Testing"><a class="docs-heading-anchor" href="#Testing">Testing</a><a id="Testing-1"></a><a class="docs-heading-anchor-permalink" href="#Testing" title="Permalink"></a></h2><p>You can run the unit test suite with the following command:</p><pre><code class="language-julia hljs">pkg"test KitePodModels"</code></pre><h2 id="Provides"><a class="docs-heading-anchor" href="#Provides">Provides</a><a id="Provides-1"></a><a class="docs-heading-anchor-permalink" href="#Provides" title="Permalink"></a></h2><ul><li>functions to initialize the simulator, to update the set values and to read the actual values</li><li>a function on_timer() that needs to be called once per time step</li><li>a function to convert the actual depower value into change of angle of attack</li></ul><h2 id="Step-response"><a class="docs-heading-anchor" href="#Step-response">Step response</a><a id="Step-response-1"></a><a class="docs-heading-anchor-permalink" href="#Step-response" title="Permalink"></a></h2><p><img src="step_response.png" alt="Step Response"/></p><p>Click on <strong>Functions</strong> on the left to see the exported functions.</p><h2 id="Related"><a class="docs-heading-anchor" href="#Related">Related</a><a id="Related-1"></a><a class="docs-heading-anchor-permalink" href="#Related" title="Permalink"></a></h2><ul><li>The meta package <a href="https://github.com/aenarete/KiteSimulators.jl">KiteSimulators</a> which contains all packages from Julia Kite Power Tools.</li><li>the package <a href="https://github.com/ufechner7/KiteUtils.jl">KiteUtils</a></li><li>the packages <a href="https://github.com/ufechner7/KiteModels.jl">KiteModels</a> and <a href="https://github.com/aenarete/WinchModels.jl">WinchModels</a> and <a href="https://github.com/aenarete/AtmosphericModels.jl">AtmosphericModels</a></li><li>the packages <a href="https://github.com/aenarete/KiteControllers.jl">KiteControllers</a> and<a href="https://github.com/aenarete/KiteViewers.jl">KiteViewers</a></li></ul><p>Author: Uwe Fechner ([email protected])</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="types/">Types »</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><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Friday 9 August 2024 11:08">Friday 9 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.