-
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
Nov 14, 2024
1 parent
44f0379
commit b2d7481
Showing
6 changed files
with
11 additions
and
11 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.11.1","generation_timestamp":"2024-11-14T17:56:51","documenter_version":"1.8.0"}} | ||
| {"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-14T18:03:32","documenter_version":"1.8.0"}} |
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
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,4 +1,4 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · KiteUtils.jl</title><meta name="title" content="Home · KiteUtils.jl"/><meta property="og:title" content="Home · KiteUtils.jl"/><meta property="twitter:title" content="Home · KiteUtils.jl"/><meta name="description" content="Documentation for KiteUtils.jl."/><meta property="og:description" content="Documentation for KiteUtils.jl."/><meta property="twitter:description" content="Documentation for KiteUtils.jl."/><meta property="og:url" content="https://ufechner7.github.io/KiteUtils.jl/"/><meta property="twitter:url" content="https://ufechner7.github.io/KiteUtils.jl/"/><link rel="canonical" href="https://ufechner7.github.io/KiteUtils.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"><div class="docs-package-name"><span class="docs-autofit"><a href>KiteUtils.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="#What-to-install"><span>What to install</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="#Features"><span>Features</span></a></li><li><a class="tocitem" href="#Related"><span>Related</span></a></li></ul></li><li><a class="tocitem" href="reference_frames/">Reference frames</a></li><li><a class="tocitem" href="functions/">Exported Functions</a></li><li><a class="tocitem" href="types/">Exported Types</a></li><li><a class="tocitem" href="examples/">Examples</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/ufechner7/KiteUtils.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="KiteUtils"><a class="docs-heading-anchor" href="#KiteUtils">KiteUtils</a><a id="KiteUtils-1"></a><a class="docs-heading-anchor-permalink" href="#KiteUtils" title="Permalink"></a></h1><p>Documentation for <a href="https://github.com/ufechner7/KiteUtils.jl">KiteUtils</a>.</p><p>This package is the foundation of Julia Kite Power Tools, which consist of the following packages:</p><p><img src="kite_power_tools.png" alt="Julia Kite Power Tools"/></p><h2 id="What-to-install"><a class="docs-heading-anchor" href="#What-to-install">What to install</a><a id="What-to-install-1"></a><a class="docs-heading-anchor-permalink" href="#What-to-install" title="Permalink"></a></h2><p>If you want to run simulations and see the results in 3D, please install the meta package <a href="https://github.com/aenarete/KiteSimulators.jl">KiteSimulators</a> . If you have already KiteSimulators installed, use <code>using KiteSimulators</code> instead of <code>using KiteUtils</code>. If you just want to learn how this package works quickly just install only this package.</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>Install <a href="https://ufechner7.github.io/2024/08/09/installing-julia-with-juliaup.html">Julia 1.10</a> or later, if you haven't already. You can add KiteUtils from Julia's package manager, by typing </p><pre><code class="language-julia hljs">using Pkg | ||
| pkg"add KiteUtils"</code></pre><p>at the Julia prompt.</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 tests of this package with the command:</p><pre><code class="language-julia hljs">using Pkg | ||
| pkg"test KiteUtils"</code></pre><h2 id="Features"><a class="docs-heading-anchor" href="#Features">Features</a><a id="Features-1"></a><a class="docs-heading-anchor-permalink" href="#Features" title="Permalink"></a></h2><ul><li>read configuration files, written in .yaml format</li><li>provides the default configuration file <a href="https://github.com/ufechner7/KiteUtils.jl/blob/main/data/settings.yaml">settings.yaml</a></li><li>log the system state and read and write log files, memory efficient and fast due to the use of the Apache Arrow format</li><li>present log files in two different formats, one optimized to look at the system state at one point in time, and one that presents per-variable arrays with the time as index</li><li>functions for coordinate system transformations</li><li>provides types for the state of a kite power system, for logfiles and for configuration parameters</li></ul><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 packages <a href="https://github.com/ufechner7/KiteModels.jl">KiteModels</a> and <a href="https://github.com/aenarete/KitePodModels.jl">KitePodModels</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 package <a href="https://github.com/aenarete/KiteControllers.jl">KiteControllers</a> and <a href="https://github.com/aenarete/KiteViewers.jl">KiteViewers</a></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="reference_frames/">Reference frames »</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.8.0 on <span class="colophon-date" title="Thursday 14 November 2024 17:56">Thursday 14 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> | ||
| pkg"test KiteUtils"</code></pre><h2 id="Features"><a class="docs-heading-anchor" href="#Features">Features</a><a id="Features-1"></a><a class="docs-heading-anchor-permalink" href="#Features" title="Permalink"></a></h2><ul><li>read configuration files, written in .yaml format</li><li>provides the default configuration file <a href="https://github.com/ufechner7/KiteUtils.jl/blob/main/data/settings.yaml">settings.yaml</a></li><li>log the system state and read and write log files, memory efficient and fast due to the use of the Apache Arrow format</li><li>present log files in two different formats, one optimized to look at the system state at one point in time, and one that presents per-variable arrays with the time as index</li><li>functions for coordinate system transformations</li><li>provides types for the state of a kite power system, for logfiles and for configuration parameters</li></ul><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 packages <a href="https://github.com/ufechner7/KiteModels.jl">KiteModels</a> and <a href="https://github.com/aenarete/KitePodModels.jl">KitePodModels</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 package <a href="https://github.com/aenarete/KiteControllers.jl">KiteControllers</a> and <a href="https://github.com/aenarete/KiteViewers.jl">KiteViewers</a></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="reference_frames/">Reference frames »</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.8.0 on <span class="colophon-date" title="Thursday 14 November 2024 18:03">Thursday 14 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
Oops, something went wrong.