Skip to content

Commit

Permalink
build based on d2e767d
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Aug 28, 2023
1 parent 75e0e22 commit deec362
Show file tree
Hide file tree
Showing 8 changed files with 11 additions and 10 deletions.
2 changes: 1 addition & 1 deletion dev/index.html
View file
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 · SpaceIndices.jl</title><script data-outdated-warner src="assets/warner.js"></script><link rel="canonical" href="https://juliaspace.github.io/SpaceIndices.jl/stable/"/><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.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/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>SpaceIndices.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><ul class="internal"><li><a class="tocitem" href="#Installation"><span>Installation</span></a></li></ul></li><li><a class="tocitem" href="man/quick_start/">Quick start</a></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="man/initialization/">Initialization</a></li><li><a class="tocitem" href="man/get/">Get space indices</a></li><li><a class="tocitem" href="man/api/">API</a></li></ul></li><li><a class="tocitem" href="lib/library/">Library</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/JuliaSpace/SpaceIndices.jl/blob/main/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="SpaceIndices.jl"><a class="docs-heading-anchor" href="#SpaceIndices.jl">SpaceIndices.jl</a><a id="SpaceIndices.jl-1"></a><a class="docs-heading-anchor-permalink" href="#SpaceIndices.jl" title="Permalink"></a></h1><p>This package allows to automatically fetch and parse space indices.</p><p>The space index sets supported in this version are:</p><table><tr><th style="text-align: left"><strong>Space Index Set</strong></th><th style="text-align: left"><strong>File</strong></th><th style="text-align: left"><strong>Expiry period</strong></th><th style="text-align: left"><strong>Information</strong></th></tr><tr><td style="text-align: left"><code>Celestrak</code></td><td style="text-align: left"><code>SW-All.csv</code></td><td style="text-align: left">1 day</td><td style="text-align: left">F10.7, AP, KP, ISN, C9, Cp, ND, BSRN (historic and predicted).</td></tr><tr><td style="text-align: left"><code>JB2008</code></td><td style="text-align: left"><code>DTCFILE.TXT</code></td><td style="text-align: left">1 day</td><td style="text-align: left">Exospheric temperature variation caused by the Dst index.</td></tr><tr><td style="text-align: left"></td><td style="text-align: left"><code>SOLFSMY.TXT</code></td><td style="text-align: left">1 day</td><td style="text-align: left">Indices necessary for the JB2008 atmospheric model.</td></tr></table><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>This package can be installed using:</p><pre><code class="language-julia hljs">julia&gt; using Pkg
julia&gt; Pkg.add(&quot;SpaceIndices&quot;)</code></pre></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="man/quick_start/">Quick start »</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.25 on <span class="colophon-date" title="Thursday 17 August 2023 13:24">Thursday 17 August 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
julia&gt; Pkg.add(&quot;SpaceIndices&quot;)</code></pre></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="man/quick_start/">Quick start »</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.25 on <span class="colophon-date" title="Monday 28 August 2023 16:26">Monday 28 August 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
4 changes: 2 additions & 2 deletions dev/lib/library/index.html
View file

Large diffs are not rendered by default.

5 changes: 3 additions & 2 deletions dev/man/api/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
end

return MySpaceIndex(...)
end</code></pre><p>Finally, the new space index set must also implement a set of functions with the following signature:</p><pre><code class="language-julia hljs">SpaceIndices.space_index(::Val{:index}, instant::DateTime; kwargs...) -&gt; Number</code></pre><p>where the space <code>index</code> for the <code>instant</code> will be returned.</p><h2 id="Optional-API-Functions"><a class="docs-heading-anchor" href="#Optional-API-Functions">Optional API Functions</a><a id="Optional-API-Functions-1"></a><a class="docs-heading-anchor-permalink" href="#Optional-API-Functions" title="Permalink"></a></h2><pre><code class="language-julia hljs">function SpaceIndices.filenames(::Type{T}) where T&lt;:SpaceIndexFile -&gt; Vector{String}</code></pre><p>This function can return a <code>Vector{String}</code> with the names of the remote files. The system will used this information to save the data in the package scratch space. For example:</p><pre><code class="language-julia hljs">SpaceIndices.filenames(::Type{MySpaceIndex}) = [&quot;my_space_file.txt&quot;]</code></pre><p>If this function is not defined, the filename will be obtained from the URL using the function <code>basename</code>.</p><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>All functions that return a <code>Vector</code> must return an array with <strong>the same number of elements</strong>.</p></div></div><h2 id="Example:-Leap-Seconds"><a class="docs-heading-anchor" href="#Example:-Leap-Seconds">Example: Leap Seconds</a><a id="Example:-Leap-Seconds-1"></a><a class="docs-heading-anchor-permalink" href="#Example:-Leap-Seconds" title="Permalink"></a></h2><p>We will use the API to define a new space index set that has the GPS leap seconds. The file has a CSV-like format but the values are separated by <code>;</code>. It has two columns. The first contains the Julian days in which the leap seconds were modified to the values in the second column:</p><pre><code class="language-text hljs">Julian Day;Leap Seconds
end</code></pre><p>Finally, the new space index set must also implement a set of functions with the following signature:</p><pre><code class="language-julia hljs">SpaceIndices.space_index(::Val{:index}, instant::DateTime; kwargs...) -&gt; Number
SpaceIndices.space_index(::Val{:index}, jd::Number; kwargs...) -&gt; Number</code></pre><p>where the space <code>index</code> for the <code>instant</code> will be returned.</p><h2 id="Optional-API-Functions"><a class="docs-heading-anchor" href="#Optional-API-Functions">Optional API Functions</a><a id="Optional-API-Functions-1"></a><a class="docs-heading-anchor-permalink" href="#Optional-API-Functions" title="Permalink"></a></h2><pre><code class="language-julia hljs">function SpaceIndices.filenames(::Type{T}) where T&lt;:SpaceIndexFile -&gt; Vector{String}</code></pre><p>This function can return a <code>Vector{String}</code> with the names of the remote files. The system will used this information to save the data in the package scratch space. For example:</p><pre><code class="language-julia hljs">SpaceIndices.filenames(::Type{MySpaceIndex}) = [&quot;my_space_file.txt&quot;]</code></pre><p>If this function is not defined, the filename will be obtained from the URL using the function <code>basename</code>.</p><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>All functions that return a <code>Vector</code> must return an array with <strong>the same number of elements</strong>.</p></div></div><h2 id="Example:-Leap-Seconds"><a class="docs-heading-anchor" href="#Example:-Leap-Seconds">Example: Leap Seconds</a><a id="Example:-Leap-Seconds-1"></a><a class="docs-heading-anchor-permalink" href="#Example:-Leap-Seconds" title="Permalink"></a></h2><p>We will use the API to define a new space index set that has the GPS leap seconds. The file has a CSV-like format but the values are separated by <code>;</code>. It has two columns. The first contains the Julian days in which the leap seconds were modified to the values in the second column:</p><pre><code class="language-text hljs">Julian Day;Leap Seconds
2441499.500000;11.0
2441683.500000;12.0
2442048.500000;13.0
Expand Down Expand Up @@ -40,4 +41,4 @@
[ Info: Downloading the file &#39;SW-All.csv&#39; from &#39;https://celestrak.org/SpaceData/SW-All.csv&#39;...

julia&gt; space_index(Val(:LeapSeconds), now())
37.0</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../get/">« Get space indices</a><a class="docs-footer-nextpage" href="../../lib/library/">Library »</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.25 on <span class="colophon-date" title="Thursday 17 August 2023 13:24">Thursday 17 August 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
37.0</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../get/">« Get space indices</a><a class="docs-footer-nextpage" href="../../lib/library/">Library »</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.25 on <span class="colophon-date" title="Monday 28 August 2023 16:26">Monday 28 August 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 deec362

Please sign in to comment.