Deploy to GitHub pages

simpeg · Oct 15, 2024 · 6c001b6 · 6c001b6
commit 6c001b6
Show file tree

Hide file tree

Showing 325 changed files with 199,748 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: fe9a4a2eae292b565ce5306a8c428678
+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_operate_aurora.nbconvert_66_1.png b/_images/examples_operate_aurora.nbconvert_66_1.png
diff --git a/_images/examples_operate_aurora.nbconvert_66_3.png b/_images/examples_operate_aurora.nbconvert_66_3.png
diff --git a/_images/examples_operate_aurora.nbconvert_66_5.png b/_images/examples_operate_aurora.nbconvert_66_5.png
diff --git a/_images/examples_operate_aurora.nbconvert_66_7.png b/_images/examples_operate_aurora.nbconvert_66_7.png
diff --git a/_images/examples_operate_aurora_66_1.png b/_images/examples_operate_aurora_66_1.png
diff --git a/_images/examples_operate_aurora_66_3.png b/_images/examples_operate_aurora_66_3.png
diff --git a/_images/examples_operate_aurora_66_5.png b/_images/examples_operate_aurora_66_5.png
diff --git a/_images/examples_operate_aurora_66_7.png b/_images/examples_operate_aurora_66_7.png
diff --git a/_images/tutorials_earthscope_magnetic_data_tutorial_101_2.png b/_images/tutorials_earthscope_magnetic_data_tutorial_101_2.png
diff --git a/_images/tutorials_earthscope_magnetic_data_tutorial_121_0.png b/_images/tutorials_earthscope_magnetic_data_tutorial_121_0.png
diff --git a/_images/tutorials_earthscope_magnetic_data_tutorial_123_1.png b/_images/tutorials_earthscope_magnetic_data_tutorial_123_1.png
diff --git a/_images/tutorials_earthscope_magnetic_data_tutorial_83_1.png b/_images/tutorials_earthscope_magnetic_data_tutorial_83_1.png
diff --git a/_images/tutorials_earthscope_magnetic_data_tutorial_84_0.png b/_images/tutorials_earthscope_magnetic_data_tutorial_84_0.png
diff --git a/_images/tutorials_earthscope_magnetic_data_tutorial_90_0.png b/_images/tutorials_earthscope_magnetic_data_tutorial_90_0.png
diff --git a/_images/tutorials_earthscope_magnetic_data_tutorial_95_2.png b/_images/tutorials_earthscope_magnetic_data_tutorial_95_2.png
diff --git a/_images/tutorials_earthscope_magnetic_data_tutorial_99_0.png b/_images/tutorials_earthscope_magnetic_data_tutorial_99_0.png
diff --git a/_images/tutorials_pkd_units_check.nbconvert_6_1.png b/_images/tutorials_pkd_units_check.nbconvert_6_1.png
diff --git a/_images/tutorials_pkd_units_check.nbconvert_6_11.png b/_images/tutorials_pkd_units_check.nbconvert_6_11.png
diff --git a/_images/tutorials_pkd_units_check.nbconvert_6_13.png b/_images/tutorials_pkd_units_check.nbconvert_6_13.png
diff --git a/_images/tutorials_pkd_units_check.nbconvert_6_15.png b/_images/tutorials_pkd_units_check.nbconvert_6_15.png
diff --git a/_images/tutorials_pkd_units_check.nbconvert_6_17.png b/_images/tutorials_pkd_units_check.nbconvert_6_17.png
diff --git a/_images/tutorials_pkd_units_check.nbconvert_6_19.png b/_images/tutorials_pkd_units_check.nbconvert_6_19.png
diff --git a/_images/tutorials_pkd_units_check.nbconvert_6_21.png b/_images/tutorials_pkd_units_check.nbconvert_6_21.png
diff --git a/_images/tutorials_pkd_units_check.nbconvert_6_23.png b/_images/tutorials_pkd_units_check.nbconvert_6_23.png
diff --git a/_images/tutorials_pkd_units_check.nbconvert_6_25.png b/_images/tutorials_pkd_units_check.nbconvert_6_25.png
diff --git a/_images/tutorials_pkd_units_check.nbconvert_6_27.png b/_images/tutorials_pkd_units_check.nbconvert_6_27.png
diff --git a/_images/tutorials_pkd_units_check.nbconvert_6_29.png b/_images/tutorials_pkd_units_check.nbconvert_6_29.png
diff --git a/_images/tutorials_pkd_units_check.nbconvert_6_3.png b/_images/tutorials_pkd_units_check.nbconvert_6_3.png
diff --git a/_images/tutorials_pkd_units_check.nbconvert_6_31.png b/_images/tutorials_pkd_units_check.nbconvert_6_31.png
diff --git a/_images/tutorials_pkd_units_check.nbconvert_6_33.png b/_images/tutorials_pkd_units_check.nbconvert_6_33.png
diff --git a/_images/tutorials_pkd_units_check.nbconvert_6_35.png b/_images/tutorials_pkd_units_check.nbconvert_6_35.png
diff --git a/_images/tutorials_pkd_units_check.nbconvert_6_37.png b/_images/tutorials_pkd_units_check.nbconvert_6_37.png
diff --git a/_images/tutorials_pkd_units_check.nbconvert_6_39.png b/_images/tutorials_pkd_units_check.nbconvert_6_39.png
diff --git a/_images/tutorials_pkd_units_check.nbconvert_6_5.png b/_images/tutorials_pkd_units_check.nbconvert_6_5.png
diff --git a/_images/tutorials_pkd_units_check.nbconvert_6_7.png b/_images/tutorials_pkd_units_check.nbconvert_6_7.png
diff --git a/_images/tutorials_pkd_units_check.nbconvert_6_9.png b/_images/tutorials_pkd_units_check.nbconvert_6_9.png
diff --git a/_images/tutorials_pkd_units_check_6_1.png b/_images/tutorials_pkd_units_check_6_1.png
diff --git a/_images/tutorials_pkd_units_check_6_11.png b/_images/tutorials_pkd_units_check_6_11.png
diff --git a/_images/tutorials_pkd_units_check_6_12.png b/_images/tutorials_pkd_units_check_6_12.png
diff --git a/_images/tutorials_pkd_units_check_6_14.png b/_images/tutorials_pkd_units_check_6_14.png
diff --git a/_images/tutorials_pkd_units_check_6_15.png b/_images/tutorials_pkd_units_check_6_15.png
diff --git a/_images/tutorials_pkd_units_check_6_17.png b/_images/tutorials_pkd_units_check_6_17.png
diff --git a/_images/tutorials_pkd_units_check_6_18.png b/_images/tutorials_pkd_units_check_6_18.png
diff --git a/_images/tutorials_pkd_units_check_6_20.png b/_images/tutorials_pkd_units_check_6_20.png
diff --git a/_images/tutorials_pkd_units_check_6_21.png b/_images/tutorials_pkd_units_check_6_21.png
diff --git a/_images/tutorials_pkd_units_check_6_23.png b/_images/tutorials_pkd_units_check_6_23.png
diff --git a/_images/tutorials_pkd_units_check_6_24.png b/_images/tutorials_pkd_units_check_6_24.png
diff --git a/_images/tutorials_pkd_units_check_6_26.png b/_images/tutorials_pkd_units_check_6_26.png
diff --git a/_images/tutorials_pkd_units_check_6_27.png b/_images/tutorials_pkd_units_check_6_27.png
diff --git a/_images/tutorials_pkd_units_check_6_29.png b/_images/tutorials_pkd_units_check_6_29.png
diff --git a/_images/tutorials_pkd_units_check_6_3.png b/_images/tutorials_pkd_units_check_6_3.png
diff --git a/_images/tutorials_pkd_units_check_6_30.png b/_images/tutorials_pkd_units_check_6_30.png
diff --git a/_images/tutorials_pkd_units_check_6_5.png b/_images/tutorials_pkd_units_check_6_5.png
diff --git a/_images/tutorials_pkd_units_check_6_6.png b/_images/tutorials_pkd_units_check_6_6.png
diff --git a/_images/tutorials_pkd_units_check_6_8.png b/_images/tutorials_pkd_units_check_6_8.png
diff --git a/_images/tutorials_pkd_units_check_6_9.png b/_images/tutorials_pkd_units_check_6_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_process_cas04_multiple_station.nbconvert_23_1.png b/_images/tutorials_process_cas04_multiple_station.nbconvert_23_1.png
diff --git a/_images/tutorials_process_cas04_multiple_station.nbconvert_23_3.png b/_images/tutorials_process_cas04_multiple_station.nbconvert_23_3.png
diff --git a/_images/tutorials_process_cas04_multiple_station.nbconvert_23_5.png b/_images/tutorials_process_cas04_multiple_station.nbconvert_23_5.png
diff --git a/_images/tutorials_process_cas04_multiple_station.nbconvert_23_7.png b/_images/tutorials_process_cas04_multiple_station.nbconvert_23_7.png
diff --git a/_images/tutorials_process_cas04_multiple_station.nbconvert_29_1.png b/_images/tutorials_process_cas04_multiple_station.nbconvert_29_1.png
diff --git a/_images/tutorials_process_cas04_multiple_station.nbconvert_40_1.png b/_images/tutorials_process_cas04_multiple_station.nbconvert_40_1.png
diff --git a/_images/tutorials_process_cas04_multiple_station.nbconvert_40_3.png b/_images/tutorials_process_cas04_multiple_station.nbconvert_40_3.png
diff --git a/_images/tutorials_process_cas04_multiple_station.nbconvert_40_5.png b/_images/tutorials_process_cas04_multiple_station.nbconvert_40_5.png
diff --git a/_images/tutorials_process_cas04_multiple_station.nbconvert_40_7.png b/_images/tutorials_process_cas04_multiple_station.nbconvert_40_7.png
diff --git a/_images/tutorials_process_cas04_multiple_station.nbconvert_54_0.png b/_images/tutorials_process_cas04_multiple_station.nbconvert_54_0.png
diff --git a/_images/tutorials_process_cas04_multiple_station_23_1.png b/_images/tutorials_process_cas04_multiple_station_23_1.png
diff --git a/_images/tutorials_process_cas04_multiple_station_23_3.png b/_images/tutorials_process_cas04_multiple_station_23_3.png
diff --git a/_images/tutorials_process_cas04_multiple_station_23_5.png b/_images/tutorials_process_cas04_multiple_station_23_5.png
diff --git a/_images/tutorials_process_cas04_multiple_station_23_7.png b/_images/tutorials_process_cas04_multiple_station_23_7.png
diff --git a/_images/tutorials_process_cas04_multiple_station_29_1.png b/_images/tutorials_process_cas04_multiple_station_29_1.png
diff --git a/_images/tutorials_process_cas04_multiple_station_40_1.png b/_images/tutorials_process_cas04_multiple_station_40_1.png
diff --git a/_images/tutorials_process_cas04_multiple_station_40_3.png b/_images/tutorials_process_cas04_multiple_station_40_3.png
diff --git a/_images/tutorials_process_cas04_multiple_station_40_5.png b/_images/tutorials_process_cas04_multiple_station_40_5.png
diff --git a/_images/tutorials_process_cas04_multiple_station_40_7.png b/_images/tutorials_process_cas04_multiple_station_40_7.png
diff --git a/_images/tutorials_process_cas04_multiple_station_54_0.png b/_images/tutorials_process_cas04_multiple_station_54_0.png
diff --git a/_images/tutorials_synthetic_data_processing.nbconvert_19_1.png b/_images/tutorials_synthetic_data_processing.nbconvert_19_1.png
diff --git a/_images/tutorials_synthetic_data_processing.nbconvert_19_3.png b/_images/tutorials_synthetic_data_processing.nbconvert_19_3.png
diff --git a/_images/tutorials_synthetic_data_processing.nbconvert_19_5.png b/_images/tutorials_synthetic_data_processing.nbconvert_19_5.png
diff --git a/_images/tutorials_synthetic_data_processing.nbconvert_19_7.png b/_images/tutorials_synthetic_data_processing.nbconvert_19_7.png
diff --git a/_images/tutorials_synthetic_data_processing_19_1.png b/_images/tutorials_synthetic_data_processing_19_1.png
diff --git a/_images/tutorials_synthetic_data_processing_19_3.png b/_images/tutorials_synthetic_data_processing_19_3.png
diff --git a/_images/tutorials_synthetic_data_processing_19_5.png b/_images/tutorials_synthetic_data_processing_19_5.png
diff --git a/_images/tutorials_synthetic_data_processing_19_7.png b/_images/tutorials_synthetic_data_processing_19_7.png
diff --git a/_modules/aurora/config/config_creator.html b/_modules/aurora/config/config_creator.html
diff --git a/_modules/aurora/config/metadata/processing.html b/_modules/aurora/config/metadata/processing.html
diff --git a/_modules/aurora/general_helper_functions.html b/_modules/aurora/general_helper_functions.html
diff --git a/_modules/aurora/pipelines/fourier_coefficients.html b/_modules/aurora/pipelines/fourier_coefficients.html
diff --git a/_modules/aurora/pipelines/helpers.html b/_modules/aurora/pipelines/helpers.html
@@ -0,0 +1,183 @@
+
+
+<!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.pipelines.helpers &mdash; aurora 0.3.13 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=e59714d7" />
+      <link rel="stylesheet" type="text/css" href="../../../_static/plot_directive.css" />
+      <link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css?v=d2d258e8" />
+      <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" />
+
+
+      <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=d0ab9f1a"></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-Earthscope-archives">1. Build an MTH5 file from Earthscope archives</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>
+<li class="toctree-l1"><a class="reference internal" href="../../../examples/operate_aurora.html#To-process-only-a-segment-of-data">To process only a segment of data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../examples/operate_aurora.html#Exercise:">Exercise:</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../examples/operate_aurora.html#id1">Exercise:</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../examples/dataset_definition.html">Dataset Definition DataFrame</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../examples/dataset_definition.html#Excercise:">Excercise:</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/processing_configuration.html">Processing Configuration</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/processing_configuration.html#Example-of-making-a-KernelDataset-from-an-mth5">Example of making a KernelDataset from an mth5</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/processing_configuration.html#EMTF-Band-Setup-File">EMTF Band Setup File</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/earthscope_magnetic_data_tutorial.html">Accessing Magnetic Field Data from EarthScope Using MTH5</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/earthscope_magnetic_data_tutorial.html#0.-Getting-started">0. Getting started</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/earthscope_magnetic_data_tutorial.html#1.-Exploring-the-data-at-EarthScope">1. Exploring the data at EarthScope</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/earthscope_magnetic_data_tutorial.html#2.-Case-Study:">2. Case Study:</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/earthscope_magnetic_data_tutorial.html#3.-Define-request-dataframe">3. Define request dataframe</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/earthscope_magnetic_data_tutorial.html#4.-Build-MTH5">4. Build MTH5</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/earthscope_magnetic_data_tutorial.html#5.-Build-MTH5-(with-data)">5. Build MTH5 (with data)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/earthscope_magnetic_data_tutorial.html#6.-Calibrating-time-series">6. Calibrating time series</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/earthscope_magnetic_data_tutorial.html#7.-Comparison-of-time-series">7. Comparison of time series</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/earthscope_magnetic_data_tutorial.html#TODO:-9.-Access-USGS-data-directly">TODO: 9. Access USGS data directly</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/process_cas04_multiple_station.html">Process CAS04 with Remote Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/process_cas04_multiple_station.html#Make-MTH5-from-IRIS-Data-Managment-Center-v0.2.0">Make MTH5 from IRIS Data Managment Center v0.2.0</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/process_cas04_multiple_station.html#To-compare-with-the-archived-file,-we-need-to-set-the-coordinate-system-to-geographic">To compare with the archived file, we need to set the coordinate system to geographic</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/process_cas04_multiple_station.html#Part-II:-Logic-to-save-FCs">Part II: Logic to save FCs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/process_cas04_multiple_station.html#Now-that-the-FCs-are-saved-we-can-access-them:|">Now that the FCs are saved we can access them:|</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/process_cas04_multiple_station.html#Absolute-Minimal-Example">Absolute Minimal Example</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/synthetic_data_processing.html">Synthetic Data Tutorial</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/synthetic_data_processing.html#Feature-Storage-Experimental-work-in-progress">Feature Storage <strong>Experimental work in progress</strong></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/modules.html">aurora</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.pipelines.helpers</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.pipelines.helpers</h1><div class="highlight"><pre>
+<span></span><span class="sd">&quot;&quot;&quot;</span>
+
+<span class="sd">    Helper functions for processing pipelines.</span>
+<span class="sd">    These maybe reorganized later into other modules.</span>
+
+<span class="sd">&quot;&quot;&quot;</span>
+
+<span class="kn">from</span> <span class="nn">mt_metadata.transfer_functions.processing.aurora</span> <span class="kn">import</span> <span class="n">Processing</span>
+<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Union</span>
+<span class="kn">import</span> <span class="nn">pathlib</span>
+
+
+<div class="viewcode-block" id="initialize_config"><a class="viewcode-back" href="../../../api/aurora.pipelines.html#aurora.pipelines.helpers.initialize_config">[docs]</a><span class="k">def</span> <span class="nf">initialize_config</span><span class="p">(</span>
+    <span class="n">processing_config</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">Processing</span><span class="p">,</span> <span class="nb">str</span><span class="p">,</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">]</span>
+<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Processing</span><span class="p">:</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Helper function to return an intialized processing config.</span>
+
+<span class="sd">    Parameters</span>
+<span class="sd">    ----------</span>
+<span class="sd">    processing_cfg: Union[Processing, str, pathlib.Path]</span>
+<span class="sd">        Either an instance of the processing class or a path to a json file that a</span>
+<span class="sd">        Processing object is stored in.</span>
+
+<span class="sd">    Returns</span>
+<span class="sd">    -------</span>
+<span class="sd">    config: mt_metadata.transfer_functions.processing.aurora.Processing</span>
+<span class="sd">        Object that contains the processing parameters</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">processing_config</span><span class="p">,</span> <span class="p">(</span><span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">,</span> <span class="nb">str</span><span class="p">)):</span>
+        <span class="n">config</span> <span class="o">=</span> <span class="n">Processing</span><span class="p">()</span>
+        <span class="n">config</span><span class="o">.</span><span class="n">from_json</span><span class="p">(</span><span class="n">processing_config</span><span class="p">)</span>
+    <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">processing_config</span><span class="p">,</span> <span class="n">Processing</span><span class="p">):</span>
+        <span class="n">config</span> <span class="o">=</span> <span class="n">processing_config</span>
+    <span class="k">else</span><span class="p">:</span>
+        <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Unrecognized config of type </span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="n">processing_config</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
+    <span class="k">return</span> <span class="n">config</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>