Deploy to GitHub pages

simpeg · Apr 2, 2024 · 78d17af · 78d17af
commit 78d17af
Show file tree

Hide file tree

Showing 187 changed files with 108,381 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 827bf94c0bbc86979e3ac69623a2e370
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.nojekyll b/.nojekyll
diff --git a/_downloads/bc82bea3a5dd7bdba60b65220891d9e5/examples_python.zip b/_downloads/bc82bea3a5dd7bdba60b65220891d9e5/examples_python.zip
diff --git a/_images/aurora_logo.png b/_images/aurora_logo.png
diff --git a/_images/examples_earthscope_magnetic_data_tutorial_101_2.png b/_images/examples_earthscope_magnetic_data_tutorial_101_2.png
diff --git a/_images/examples_earthscope_magnetic_data_tutorial_121_0.png b/_images/examples_earthscope_magnetic_data_tutorial_121_0.png
diff --git a/_images/examples_earthscope_magnetic_data_tutorial_123_1.png b/_images/examples_earthscope_magnetic_data_tutorial_123_1.png
diff --git a/_images/examples_earthscope_magnetic_data_tutorial_83_1.png b/_images/examples_earthscope_magnetic_data_tutorial_83_1.png
diff --git a/_images/examples_earthscope_magnetic_data_tutorial_84_0.png b/_images/examples_earthscope_magnetic_data_tutorial_84_0.png
diff --git a/_images/examples_earthscope_magnetic_data_tutorial_90_0.png b/_images/examples_earthscope_magnetic_data_tutorial_90_0.png
diff --git a/_images/examples_earthscope_magnetic_data_tutorial_95_2.png b/_images/examples_earthscope_magnetic_data_tutorial_95_2.png
diff --git a/_images/examples_earthscope_magnetic_data_tutorial_99_0.png b/_images/examples_earthscope_magnetic_data_tutorial_99_0.png
diff --git a/_images/examples_operate_aurora.nbconvert_61_24.png b/_images/examples_operate_aurora.nbconvert_61_24.png
diff --git a/_images/examples_operate_aurora.nbconvert_61_35.png b/_images/examples_operate_aurora.nbconvert_61_35.png
diff --git a/_images/examples_operate_aurora.nbconvert_61_46.png b/_images/examples_operate_aurora.nbconvert_61_46.png
diff --git a/_images/examples_operate_aurora.nbconvert_61_56.png b/_images/examples_operate_aurora.nbconvert_61_56.png
diff --git a/_images/examples_operate_aurora_61_1.png b/_images/examples_operate_aurora_61_1.png
diff --git a/_images/examples_operate_aurora_61_3.png b/_images/examples_operate_aurora_61_3.png
diff --git a/_images/examples_operate_aurora_61_5.png b/_images/examples_operate_aurora_61_5.png
diff --git a/_images/examples_operate_aurora_61_7.png b/_images/examples_operate_aurora_61_7.png
diff --git a/_images/tutorials_pkd_units_check_4_1.png b/_images/tutorials_pkd_units_check_4_1.png
diff --git a/_images/tutorials_pkd_units_check_4_11.png b/_images/tutorials_pkd_units_check_4_11.png
diff --git a/_images/tutorials_pkd_units_check_4_12.png b/_images/tutorials_pkd_units_check_4_12.png
diff --git a/_images/tutorials_pkd_units_check_4_14.png b/_images/tutorials_pkd_units_check_4_14.png
diff --git a/_images/tutorials_pkd_units_check_4_15.png b/_images/tutorials_pkd_units_check_4_15.png
diff --git a/_images/tutorials_pkd_units_check_4_17.png b/_images/tutorials_pkd_units_check_4_17.png
diff --git a/_images/tutorials_pkd_units_check_4_18.png b/_images/tutorials_pkd_units_check_4_18.png
diff --git a/_images/tutorials_pkd_units_check_4_20.png b/_images/tutorials_pkd_units_check_4_20.png
diff --git a/_images/tutorials_pkd_units_check_4_21.png b/_images/tutorials_pkd_units_check_4_21.png
diff --git a/_images/tutorials_pkd_units_check_4_23.png b/_images/tutorials_pkd_units_check_4_23.png
diff --git a/_images/tutorials_pkd_units_check_4_24.png b/_images/tutorials_pkd_units_check_4_24.png
diff --git a/_images/tutorials_pkd_units_check_4_26.png b/_images/tutorials_pkd_units_check_4_26.png
diff --git a/_images/tutorials_pkd_units_check_4_27.png b/_images/tutorials_pkd_units_check_4_27.png
diff --git a/_images/tutorials_pkd_units_check_4_29.png b/_images/tutorials_pkd_units_check_4_29.png
diff --git a/_images/tutorials_pkd_units_check_4_3.png b/_images/tutorials_pkd_units_check_4_3.png
diff --git a/_images/tutorials_pkd_units_check_4_30.png b/_images/tutorials_pkd_units_check_4_30.png
diff --git a/_images/tutorials_pkd_units_check_4_5.png b/_images/tutorials_pkd_units_check_4_5.png
diff --git a/_images/tutorials_pkd_units_check_4_6.png b/_images/tutorials_pkd_units_check_4_6.png
diff --git a/_images/tutorials_pkd_units_check_4_8.png b/_images/tutorials_pkd_units_check_4_8.png
diff --git a/_images/tutorials_pkd_units_check_4_9.png b/_images/tutorials_pkd_units_check_4_9.png
diff --git a/...s/tutorials_pole_zero_fitting_lemi_pole_zero_fitting_example.nbconvert_13_0.png b/...s/tutorials_pole_zero_fitting_lemi_pole_zero_fitting_example.nbconvert_13_0.png
diff --git a/...s/tutorials_pole_zero_fitting_lemi_pole_zero_fitting_example.nbconvert_18_1.png b/...s/tutorials_pole_zero_fitting_lemi_pole_zero_fitting_example.nbconvert_18_1.png
diff --git a/...s/tutorials_pole_zero_fitting_lemi_pole_zero_fitting_example.nbconvert_20_0.png b/...s/tutorials_pole_zero_fitting_lemi_pole_zero_fitting_example.nbconvert_20_0.png
diff --git a/...s/tutorials_pole_zero_fitting_lemi_pole_zero_fitting_example.nbconvert_37_0.png b/...s/tutorials_pole_zero_fitting_lemi_pole_zero_fitting_example.nbconvert_37_0.png
diff --git a/...s/tutorials_pole_zero_fitting_lemi_pole_zero_fitting_example.nbconvert_40_1.png b/...s/tutorials_pole_zero_fitting_lemi_pole_zero_fitting_example.nbconvert_40_1.png
diff --git a/_images/tutorials_pole_zero_fitting_lemi_pole_zero_fitting_example_13_0.png b/_images/tutorials_pole_zero_fitting_lemi_pole_zero_fitting_example_13_0.png
diff --git a/_images/tutorials_pole_zero_fitting_lemi_pole_zero_fitting_example_18_1.png b/_images/tutorials_pole_zero_fitting_lemi_pole_zero_fitting_example_18_1.png
diff --git a/_images/tutorials_pole_zero_fitting_lemi_pole_zero_fitting_example_20_0.png b/_images/tutorials_pole_zero_fitting_lemi_pole_zero_fitting_example_20_0.png
diff --git a/_images/tutorials_pole_zero_fitting_lemi_pole_zero_fitting_example_37_0.png b/_images/tutorials_pole_zero_fitting_lemi_pole_zero_fitting_example_37_0.png
diff --git a/_images/tutorials_pole_zero_fitting_lemi_pole_zero_fitting_example_40_1.png b/_images/tutorials_pole_zero_fitting_lemi_pole_zero_fitting_example_40_1.png
diff --git a/_images/tutorials_synthetic_data_processing.nbconvert_18_24.png b/_images/tutorials_synthetic_data_processing.nbconvert_18_24.png
diff --git a/_images/tutorials_synthetic_data_processing.nbconvert_18_35.png b/_images/tutorials_synthetic_data_processing.nbconvert_18_35.png
diff --git a/_images/tutorials_synthetic_data_processing.nbconvert_18_46.png b/_images/tutorials_synthetic_data_processing.nbconvert_18_46.png
diff --git a/_images/tutorials_synthetic_data_processing.nbconvert_18_56.png b/_images/tutorials_synthetic_data_processing.nbconvert_18_56.png
diff --git a/_modules/aurora/general_helper_functions.html b/_modules/aurora/general_helper_functions.html
diff --git a/_modules/aurora/pipelines/process_mth5.html b/_modules/aurora/pipelines/process_mth5.html
diff --git a/_modules/aurora/pipelines/time_series_helpers.html b/_modules/aurora/pipelines/time_series_helpers.html
diff --git a/_modules/aurora/pipelines/transfer_function_helpers.html b/_modules/aurora/pipelines/transfer_function_helpers.html
diff --git a/_modules/aurora/time_series/apodization_window.html b/_modules/aurora/time_series/apodization_window.html
diff --git a/_modules/aurora/time_series/decorators.html b/_modules/aurora/time_series/decorators.html
@@ -0,0 +1,172 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>aurora.time_series.decorators &mdash; aurora 0.0.1 documentation</title>
+      <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
+      <link rel="stylesheet" type="text/css" href="../../../_static/plot_directive.css" />
+      <link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css?v=61a4c737" />
+      <link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css?v=f4aeca0c" />
+      <link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css?v=2082cf3c" />
+      <link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css?v=1277b6f3" />
+
+
+  <!--[if lt IE 9]>
+    <script src="../../../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=f6245a2f"></script>
+        <script src="../../../_static/doctools.js?v=888ff710"></script>
+        <script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
+        <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
+    <script src="../../../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../../../genindex.html" />
+    <link rel="search" title="Search" href="../../../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../../../index.html" class="icon icon-home">
+            aurora
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">User Documentation</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../user-docs/installing.html">Installing</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Examples</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../examples/operate_aurora.html">Build an MTH5 and Operate the Aurora Pipeline</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../examples/operate_aurora.html#1.-Build-an-MTH5-file-from-information-extracted-by-IRIS">1. Build an MTH5 file from information extracted by IRIS</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../examples/operate_aurora.html#2:-Process-Data">2: Process Data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../examples/operate_aurora.html#Here-is-one-way-to-select-a-single-run:">Here is one way to select a single run:</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../examples/operate_aurora.html#To-discard-runs-that-are-not-very-long">To discard runs that are not very long</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Reference documentation</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../api/index.html">API Reference</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../../../index.html">aurora</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
+          <li class="breadcrumb-item"><a href="../../index.html">Module code</a></li>
+      <li class="breadcrumb-item active">aurora.time_series.decorators</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>Source code for aurora.time_series.decorators</h1><div class="highlight"><pre>
+<span></span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">| Here is the decorator pattern</span>
+<span class="sd">| def decorator(func):</span>
+<span class="sd">|    @functools.wraps(func)</span>
+<span class="sd">|    def wrapper_decorator(\*args, \*\*kwargs):</span>
+<span class="sd">|        # Do something before</span>
+<span class="sd">|        value = func\*args, \*\*kwargs)</span>
+<span class="sd">|        # Do something after</span>
+<span class="sd">|        return value</span>
+<span class="sd">|    return wrapper_decorator</span>
+<span class="sd">&quot;&quot;&quot;</span>
+
+<span class="kn">import</span> <span class="nn">functools</span>
+<span class="kn">import</span> <span class="nn">xarray</span> <span class="k">as</span> <span class="nn">xr</span>
+
+
+<div class="viewcode-block" id="can_use_xr_dataarray"><a class="viewcode-back" href="../../../api/time_series.html#aurora.time_series.decorators.can_use_xr_dataarray">[docs]</a><span class="k">def</span> <span class="nf">can_use_xr_dataarray</span><span class="p">(</span><span class="n">func</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Intended as a decorator.  Most of the windowed time series methods are</span>
+<span class="sd">    intended to work with xarray.Dataset class.  But I would like to be able</span>
+<span class="sd">    to pass them xarray.DataArray objects.  This class casts a DataArray to a</span>
+<span class="sd">    Dataset, runs it through func and casts back to a DataArray.</span>
+
+<span class="sd">    A similar decorator could be written for numpy arrays.</span>
+<span class="sd">    Parameters</span>
+<span class="sd">    ----------</span>
+<span class="sd">    func</span>
+
+<span class="sd">    Returns</span>
+<span class="sd">    -------</span>
+
+<span class="sd">    &quot;&quot;&quot;</span>
+
+    <span class="nd">@functools</span><span class="o">.</span><span class="n">wraps</span><span class="p">(</span><span class="n">func</span><span class="p">)</span>
+    <span class="k">def</span> <span class="nf">wrapper_decorator</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+
+        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s2">&quot;data&quot;</span><span class="p">],</span> <span class="n">xr</span><span class="o">.</span><span class="n">DataArray</span><span class="p">):</span>
+            <span class="n">kwargs</span><span class="p">[</span><span class="s2">&quot;data&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s2">&quot;data&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">to_dataset</span><span class="p">(</span><span class="s2">&quot;channel&quot;</span><span class="p">)</span>
+            <span class="n">input_was_dataarray</span> <span class="o">=</span> <span class="kc">True</span>
+        <span class="k">else</span><span class="p">:</span>
+            <span class="n">input_was_dataarray</span> <span class="o">=</span> <span class="kc">False</span>
+
+        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">func</span><span class="p">,</span> <span class="nb">staticmethod</span><span class="p">):</span>
+            <span class="n">callable_func</span> <span class="o">=</span> <span class="n">func</span><span class="o">.</span><span class="fm">__get__</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="nb">object</span><span class="p">)</span>
+            <span class="n">processed_obj</span> <span class="o">=</span> <span class="n">callable_func</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
+        <span class="k">else</span><span class="p">:</span>
+            <span class="n">processed_obj</span> <span class="o">=</span> <span class="n">func</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
+
+        <span class="k">if</span> <span class="n">input_was_dataarray</span><span class="p">:</span>
+            <span class="n">processed_obj</span> <span class="o">=</span> <span class="n">processed_obj</span><span class="o">.</span><span class="n">to_array</span><span class="p">(</span><span class="s2">&quot;channel&quot;</span><span class="p">)</span>
+        <span class="k">return</span> <span class="n">processed_obj</span>
+
+    <span class="k">return</span> <span class="n">wrapper_decorator</span></div>
+</pre></div>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2021, Karl Kappler, Jared Peacock, Andy Frassetto, Tim Ronan, Lindsey Heagy, Douglas Oldenburg.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>