Skip to content

Commit

Permalink
build based on 63ebdbb
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Nov 4, 2024
1 parent 342e6b6 commit 014953e
Show file tree
Hide file tree
Showing 13 changed files with 24 additions and 24 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-04T10:31:49","documenter_version":"1.7.0"}}
{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-04T10:33:03","documenter_version":"1.7.0"}}
2 changes: 1 addition & 1 deletion dev/index.html
View file
Original file line number Diff line number Diff line change
@@ -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 · Vela.jl</title><meta name="title" content="Home · Vela.jl"/><meta property="og:title" content="Home · Vela.jl"/><meta property="twitter:title" content="Home · Vela.jl"/><meta name="description" content="Documentation for Vela.jl."/><meta property="og:description" content="Documentation for Vela.jl."/><meta property="twitter:description" content="Documentation for Vela.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>Vela.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></li><li><a class="tocitem" href="installation/">Installation</a></li><li><a class="tocitem" href="pyvela/">Getting started: The <code>pyvela</code> interface</a></li><li><span class="tocitem">Explanation &amp; API Reference</span><ul><li><a class="tocitem" href="precision/">Precision</a></li><li><a class="tocitem" href="quantities/">Quantities</a></li><li><a class="tocitem" href="toas/">Pulse Times of Arrival (TOAs)</a></li><li><a class="tocitem" href="timing-model/">The Timing &amp; Noise Model</a></li><li><a class="tocitem" href="residuals/">Residuals</a></li><li><a class="tocitem" href="likelihood/">The Likelihood Function and Kernels</a></li><li><a class="tocitem" href="parameters/">Parameters</a></li><li><a class="tocitem" href="priors/">Prior and Posterior distributions</a></li><li><a class="tocitem" href="red-noise/">Red noise models</a></li></ul></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/abhisrkckl/Vela.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/abhisrkckl/Vela.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="Vela.jl"><a class="docs-heading-anchor" href="#Vela.jl">Vela.jl</a><a id="Vela.jl-1"></a><a class="docs-heading-anchor-permalink" href="#Vela.jl" title="Permalink"></a></h1><p>A Bayesian pulsar timing and noise analysis package.</p><p>The <code>Vela.jl</code> project aims to develop a fast and simple-to-use framework for doing Bayesian pulsar timing &amp; noise analysis. It currently supports both narrowband and wideband TOAs along with most commonly used pulsar timing models. It can be used from Julia REPL, scripts, or notebooks. It can also be used from Python REPL, scripts, and notebooks with the help of the <code>pint2vela</code> interface.</p><p><code>Vela.jl</code> is named after the brightest radio pulsar, the Vela pulsar (J0835-4510). Also, Vēḻa (വേള, वेळ, ...) is a word meaning occasion, time, etc. in some Indian languages.</p><p>It is under active development.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="installation/">Installation »</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.7.0 on <span class="colophon-date" title="Monday 4 November 2024 10:31">Monday 4 November 2024</span>. Using Julia version 1.11.1.</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 · Vela.jl</title><meta name="title" content="Home · Vela.jl"/><meta property="og:title" content="Home · Vela.jl"/><meta property="twitter:title" content="Home · Vela.jl"/><meta name="description" content="Documentation for Vela.jl."/><meta property="og:description" content="Documentation for Vela.jl."/><meta property="twitter:description" content="Documentation for Vela.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>Vela.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></li><li><a class="tocitem" href="installation/">Installation</a></li><li><a class="tocitem" href="pyvela/">Getting started: The <code>pyvela</code> interface</a></li><li><span class="tocitem">Explanation &amp; API Reference</span><ul><li><a class="tocitem" href="precision/">Precision</a></li><li><a class="tocitem" href="quantities/">Quantities</a></li><li><a class="tocitem" href="toas/">Pulse Times of Arrival (TOAs)</a></li><li><a class="tocitem" href="timing-model/">The Timing &amp; Noise Model</a></li><li><a class="tocitem" href="residuals/">Residuals</a></li><li><a class="tocitem" href="likelihood/">The Likelihood Function and Kernels</a></li><li><a class="tocitem" href="parameters/">Parameters</a></li><li><a class="tocitem" href="priors/">Prior and Posterior distributions</a></li><li><a class="tocitem" href="red-noise/">Red noise models</a></li></ul></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/abhisrkckl/Vela.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/abhisrkckl/Vela.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="Vela.jl"><a class="docs-heading-anchor" href="#Vela.jl">Vela.jl</a><a id="Vela.jl-1"></a><a class="docs-heading-anchor-permalink" href="#Vela.jl" title="Permalink"></a></h1><p>A Bayesian pulsar timing and noise analysis package.</p><p>The <code>Vela.jl</code> project aims to develop a fast and simple-to-use framework for doing Bayesian pulsar timing &amp; noise analysis. It currently supports both narrowband and wideband TOAs along with most commonly used pulsar timing models. It can be used from Julia REPL, scripts, or notebooks. It can also be used from Python REPL, scripts, and notebooks with the help of the <code>pint2vela</code> interface.</p><p><code>Vela.jl</code> is named after the brightest radio pulsar, the Vela pulsar (J0835-4510). Also, Vēḻa (വേള, वेळ, ...) is a word meaning occasion, time, etc. in some Indian languages.</p><p>It is under active development.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="installation/">Installation »</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.7.0 on <span class="colophon-date" title="Monday 4 November 2024 10:33">Monday 4 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/installation/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@
julia&gt; Pkg.add([&quot;LocalRegistry&quot;, &quot;JuliaFormatter&quot;, &quot;BenchmarkTools&quot;, &quot;PythonCall&quot;])
julia&gt; Pkg.Registry.add(url=&quot;https://github.com/abhisrkckl/julia_registry&quot;)
julia&gt; Pkg.add(url=&quot;https://github.com/abhisrkckl/Vela.jl&quot;)
julia&gt; exit()</code></pre><p>Install the Python interface <code>pyvela</code>.</p><pre><code class="nohighlight hljs">(vela) $ pip install git+https://github.com/abhisrkckl/Vela.jl</code></pre><p>The number of threads available to <code>Vela.jl</code> for parallel processing can be controlled using the environment variables <code>JULIA_NUM_THREADS</code> (for direct use from Julia) or <code>PYTHON_JULIACALL_THREADS</code> (for use from within Python).</p><p>The <code>pyvela/examples</code> directory provides several example datasets and scripts. A basic example (using the Python wrapper) can be run like this:</p><pre><code class="nohighlight hljs">(vela) $ ./run_example_emcee.py NGC6440E.par NGC6440E.tim</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../pyvela/">Getting started: The <code>pyvela</code> interface »</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.7.0 on <span class="colophon-date" title="Monday 4 November 2024 10:31">Monday 4 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
julia&gt; exit()</code></pre><p>Install the Python interface <code>pyvela</code>.</p><pre><code class="nohighlight hljs">(vela) $ pip install git+https://github.com/abhisrkckl/Vela.jl</code></pre><p>The number of threads available to <code>Vela.jl</code> for parallel processing can be controlled using the environment variables <code>JULIA_NUM_THREADS</code> (for direct use from Julia) or <code>PYTHON_JULIACALL_THREADS</code> (for use from within Python).</p><p>The <code>pyvela/examples</code> directory provides several example datasets and scripts. A basic example (using the Python wrapper) can be run like this:</p><pre><code class="nohighlight hljs">(vela) $ ./run_example_emcee.py NGC6440E.par NGC6440E.tim</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../pyvela/">Getting started: The <code>pyvela</code> interface »</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.7.0 on <span class="colophon-date" title="Monday 4 November 2024 10:33">Monday 4 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 014953e

Please sign in to comment.