build based on fe6e7eb

dev/index.html

@@ -3,4 +3,4 @@
 julia&gt; Pkg.add(&quot;AstroLib&quot;)</code></pre><p>Older versions are also available for Julia 0.4-0.6.</p><p>Note that, in order to work, a few functions require external files, which are automatically downloaded when building the package. Should these files be missing for some reason, you will be able to load the package but some functions may not work properly. You can manually build the package with</p><pre><code class="language-julia hljs">julia&gt; Pkg.build(&quot;AstroLib&quot;)</code></pre><h2 id="Usage"><a class="docs-heading-anchor" href="#Usage">Usage</a><a id="Usage-1"></a><a class="docs-heading-anchor-permalink" href="#Usage" title="Permalink"></a></h2><p>After installing the package, you can start using AstroLib with</p><pre><code class="language-julia hljs">using AstroLib</code></pre><p>Many functions in <code>AstroLib.jl</code> are compatible with <a href="https://github.com/giordano/Measurements.jl">Measurements.jl</a> package, which allows you to define quantities with uncertainty and propagate the error when performing calculations according to <a href="https://en.wikipedia.org/wiki/Propagation_of_uncertainty">propagation of uncertainty rules</a>. For example:</p><pre><code class="language-julia hljs">julia&gt; using AstroLib, Measurements
 
 julia&gt; mag2flux(12.54 ± 0.03)
-3.499451670283562e-14 ± 9.669342299577655e-16</code></pre><h2 id="How-Can-I-Help?"><a class="docs-heading-anchor" href="#How-Can-I-Help?">How Can I Help?</a><a id="How-Can-I-Help?-1"></a><a class="docs-heading-anchor-permalink" href="#How-Can-I-Help?" title="Permalink"></a></h2><p><code>AstroLib.jl</code> is developed on <a href="https://github.com/juliaastro/AstroLib.jl">GitHub</a>. You can contribute to the project in a number of ways: by translating more routines from IDL Astronomy User’s Library, or providing brand-new functions, or even improving existing ones (make them faster and more precise). Also bug reports are encouraged.</p><h2 id="License"><a class="docs-heading-anchor" href="#License">License</a><a id="License-1"></a><a class="docs-heading-anchor-permalink" href="#License" title="Permalink"></a></h2><p>The <code>AstroLib.jl</code> package is licensed under the MIT “Expat” License. The original author is Mosè Giordano.</p><h2 id="Notes"><a class="docs-heading-anchor" href="#Notes">Notes</a><a id="Notes-1"></a><a class="docs-heading-anchor-permalink" href="#Notes" title="Permalink"></a></h2><p>This project is a work-in-progress, only few procedures have been translated so far. In addition, function syntax may change from time to time. Check <a href="https://github.com/JuliaAstro/AstroLib.jl/blob/master/TODO.md">TODO.md</a> out to see how you can help. Volunteers are welcome!</p><h2 id="Documentation"><a class="docs-heading-anchor" href="#Documentation">Documentation</a><a id="Documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Documentation" title="Permalink"></a></h2><p>Every function provided has detailed documentation that can be <a href="http://docs.julialang.org/en/stable/manual/documentation/#accessing-documentation">accessed</a> at Julia REPL with</p><pre><code class="language-julia hljs">julia&gt; ?FunctionName</code></pre><p>or with</p><pre><code class="language-julia hljs">julia&gt; @doc FunctionName</code></pre><h2 id="Related-Projects"><a class="docs-heading-anchor" href="#Related-Projects">Related Projects</a><a id="Related-Projects-1"></a><a class="docs-heading-anchor-permalink" href="#Related-Projects" title="Permalink"></a></h2><p>This is not the only effort to bundle astronomical functions written in Julia language. Other packages useful for more specific purposes are available at <a href="https://juliaastro.github.io/">JuliaAstro</a>. A list of other packages is available <a href="https://github.com/svaksha/Julia.jl/blob/master/Astronomy.md">here</a>.</p><p>Because of this, some of IDL AstroLib’s utilities are not provided in <code>AstroLib.jl</code> as they are already present in other Julia packages. Here is a list of such utilities:</p><ul><li><code>aper</code>, see <a href="https://github.com/juliaastro/Photometry.jl">Photometry.jl</a> package</li><li><code>asinh</code>, already present in Julia with the same name</li><li><code>cirrange</code>, it is equivalent to <code>mod(x, 360)</code>.  To restrict a number to the   range <code>[0, 2pi)</code> use <code>mod2pi(x)</code></li><li><code>cosmo_param</code>, see <a href="https://github.com/JuliaAstro/Cosmology.jl">Cosmology.jl</a> package</li><li><code>galage</code>, see <a href="https://github.com/JuliaAstro/Cosmology.jl">Cosmology.jl</a> package</li><li><code>glactc_pm</code>, see <a href="https://github.com/kbarbary/SkyCoords.jl">SkyCoords.jl</a> package</li><li><code>glactc</code>, see <a href="https://github.com/kbarbary/SkyCoords.jl">SkyCoords.jl</a> package</li><li><code>jplephinterp</code>, see <a href="https://github.com/helgee/JPLEphemeris.jl">JPLEphemeris.jl</a> package</li><li><code>jplephread</code>, see <a href="https://github.com/helgee/JPLEphemeris.jl">JPLEphemeris.jl</a> package</li><li><code>jplephtest</code>, see <a href="https://github.com/helgee/JPLEphemeris.jl">JPLEphemeris.jl</a> package</li><li><code>lumdist</code>, see <a href="https://github.com/JuliaAstro/Cosmology.jl">Cosmology.jl</a> package</li><li><code>readcol</code>, use <a href="http://docs.julialang.org/en/stable/stdlib/io-network/#Base.readdlm">readdlm</a>, part of Julia <code>Base.DataFmt</code> module. This is not a complete replacement for <code>readcol</code> but most of the time it does-the-right-thing even without using any option (it automatically identifies string and numerical columns) and you do not need to manually specify a variable for each column</li></ul><p>In addition, there are similar projects for Python (<a href="http://www.hs.uni-hamburg.de/DE/Ins/Per/Czesla/PyA/PyA/pyaslDoc/pyasl.html">Python AstroLib</a>) and R (<a href="http://rpackages.ianhowson.com/cran/astrolibR/">Astronomy Users Library</a>).</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="ref/">Reference »</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 31 August 2023 13:10">Thursday 31 August 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+3.499451670283562e-14 ± 9.669342299577655e-16</code></pre><h2 id="How-Can-I-Help?"><a class="docs-heading-anchor" href="#How-Can-I-Help?">How Can I Help?</a><a id="How-Can-I-Help?-1"></a><a class="docs-heading-anchor-permalink" href="#How-Can-I-Help?" title="Permalink"></a></h2><p><code>AstroLib.jl</code> is developed on <a href="https://github.com/juliaastro/AstroLib.jl">GitHub</a>. You can contribute to the project in a number of ways: by translating more routines from IDL Astronomy User’s Library, or providing brand-new functions, or even improving existing ones (make them faster and more precise). Also bug reports are encouraged.</p><h2 id="License"><a class="docs-heading-anchor" href="#License">License</a><a id="License-1"></a><a class="docs-heading-anchor-permalink" href="#License" title="Permalink"></a></h2><p>The <code>AstroLib.jl</code> package is licensed under the MIT “Expat” License. The original author is Mosè Giordano.</p><h2 id="Notes"><a class="docs-heading-anchor" href="#Notes">Notes</a><a id="Notes-1"></a><a class="docs-heading-anchor-permalink" href="#Notes" title="Permalink"></a></h2><p>This project is a work-in-progress, only few procedures have been translated so far. In addition, function syntax may change from time to time. Check <a href="https://github.com/JuliaAstro/AstroLib.jl/blob/master/TODO.md">TODO.md</a> out to see how you can help. Volunteers are welcome!</p><h2 id="Documentation"><a class="docs-heading-anchor" href="#Documentation">Documentation</a><a id="Documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Documentation" title="Permalink"></a></h2><p>Every function provided has detailed documentation that can be <a href="http://docs.julialang.org/en/stable/manual/documentation/#accessing-documentation">accessed</a> at Julia REPL with</p><pre><code class="language-julia hljs">julia&gt; ?FunctionName</code></pre><p>or with</p><pre><code class="language-julia hljs">julia&gt; @doc FunctionName</code></pre><h2 id="Related-Projects"><a class="docs-heading-anchor" href="#Related-Projects">Related Projects</a><a id="Related-Projects-1"></a><a class="docs-heading-anchor-permalink" href="#Related-Projects" title="Permalink"></a></h2><p>This is not the only effort to bundle astronomical functions written in Julia language. Other packages useful for more specific purposes are available at <a href="https://juliaastro.github.io/">JuliaAstro</a>. A list of other packages is available <a href="https://github.com/svaksha/Julia.jl/blob/master/Astronomy.md">here</a>.</p><p>Because of this, some of IDL AstroLib’s utilities are not provided in <code>AstroLib.jl</code> as they are already present in other Julia packages. Here is a list of such utilities:</p><ul><li><code>aper</code>, see <a href="https://github.com/juliaastro/Photometry.jl">Photometry.jl</a> package</li><li><code>asinh</code>, already present in Julia with the same name</li><li><code>cirrange</code>, it is equivalent to <code>mod(x, 360)</code>.  To restrict a number to the   range <code>[0, 2pi)</code> use <code>mod2pi(x)</code></li><li><code>cosmo_param</code>, see <a href="https://github.com/JuliaAstro/Cosmology.jl">Cosmology.jl</a> package</li><li><code>galage</code>, see <a href="https://github.com/JuliaAstro/Cosmology.jl">Cosmology.jl</a> package</li><li><code>glactc_pm</code>, see <a href="https://github.com/kbarbary/SkyCoords.jl">SkyCoords.jl</a> package</li><li><code>glactc</code>, see <a href="https://github.com/kbarbary/SkyCoords.jl">SkyCoords.jl</a> package</li><li><code>jplephinterp</code>, see <a href="https://github.com/helgee/JPLEphemeris.jl">JPLEphemeris.jl</a> package</li><li><code>jplephread</code>, see <a href="https://github.com/helgee/JPLEphemeris.jl">JPLEphemeris.jl</a> package</li><li><code>jplephtest</code>, see <a href="https://github.com/helgee/JPLEphemeris.jl">JPLEphemeris.jl</a> package</li><li><code>lumdist</code>, see <a href="https://github.com/JuliaAstro/Cosmology.jl">Cosmology.jl</a> package</li><li><code>readcol</code>, use <a href="http://docs.julialang.org/en/stable/stdlib/io-network/#Base.readdlm">readdlm</a>, part of Julia <code>Base.DataFmt</code> module. This is not a complete replacement for <code>readcol</code> but most of the time it does-the-right-thing even without using any option (it automatically identifies string and numerical columns) and you do not need to manually specify a variable for each column</li></ul><p>In addition, there are similar projects for Python (<a href="http://www.hs.uni-hamburg.de/DE/Ins/Per/Czesla/PyA/PyA/pyaslDoc/pyasl.html">Python AstroLib</a>) and R (<a href="http://rpackages.ianhowson.com/cran/astrolibR/">Astronomy Users Library</a>).</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="ref/">Reference »</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="Sunday 12 May 2024 17:43">Sunday 12 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>