Initial setup to work with sphinx for autodoc

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/build/html/.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: 5302078c300d42d9a369246f3737df51
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/html/_sources/cdaweb_utils.rst.txt

@@ -0,0 +1,7 @@
+cdaweb\_utils module
+====================
+
+.. automodule:: cdaweb_utils
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/chimp.rst.txt

@@ -0,0 +1,37 @@
+chimp package
+=============
+
+Submodules
+----------
+
+chimp.chimph5p module
+---------------------
+
+.. automodule:: chimp.chimph5p
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+chimp.chimpviz module
+---------------------
+
+.. automodule:: chimp.chimpviz
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+chimp.kCyl module
+-----------------
+
+.. automodule:: chimp.kCyl
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: chimp
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/embiggenUtils.rst.txt

@@ -0,0 +1,7 @@
+embiggenUtils module
+====================
+
+.. automodule:: embiggenUtils
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/gamera.rst.txt

@@ -0,0 +1,85 @@
+gamera package
+==============
+
+Submodules
+----------
+
+gamera.block\_gampp module
+--------------------------
+
+.. automodule:: gamera.block_gampp
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gamera.deltabViz module
+-----------------------
+
+.. automodule:: gamera.deltabViz
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gamera.gamGrids module
+----------------------
+
+.. automodule:: gamera.gamGrids
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gamera.gampp module
+-------------------
+
+.. automodule:: gamera.gampp
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gamera.magsphere module
+-----------------------
+
+.. automodule:: gamera.magsphere
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gamera.magsphereRescale module
+------------------------------
+
+.. automodule:: gamera.magsphereRescale
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gamera.msphViz module
+---------------------
+
+.. automodule:: gamera.msphViz
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gamera.rcmpp module
+-------------------
+
+.. automodule:: gamera.rcmpp
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gamera.remixpp module
+---------------------
+
+.. automodule:: gamera.remixpp
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: gamera
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/gamhelio.lib.rst.txt

@@ -0,0 +1,85 @@
+gamhelio.lib package
+====================
+
+Submodules
+----------
+
+gamhelio.lib.ace module
+-----------------------
+
+.. automodule:: gamhelio.lib.ace
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gamhelio.lib.cspice module
+--------------------------
+
+.. automodule:: gamhelio.lib.cspice
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gamhelio.lib.lfmhlib module
+---------------------------
+
+.. automodule:: gamhelio.lib.lfmhlib
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gamhelio.lib.mas module
+-----------------------
+
+.. automodule:: gamhelio.lib.mas
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gamhelio.lib.msgr module
+------------------------
+
+.. automodule:: gamhelio.lib.msgr
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gamhelio.lib.poisson module
+---------------------------
+
+.. automodule:: gamhelio.lib.poisson
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gamhelio.lib.util module
+------------------------
+
+.. automodule:: gamhelio.lib.util
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gamhelio.lib.wsa module
+-----------------------
+
+.. automodule:: gamhelio.lib.wsa
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gamhelio.lib.wsa2h5 module
+--------------------------
+
+.. automodule:: gamhelio.lib.wsa2h5
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: gamhelio.lib
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/gamhelio.rst.txt

@@ -0,0 +1,39 @@
+gamhelio package
+================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   gamhelio.lib
+   gamhelio.wsa2TDgamera
+   gamhelio.wsa2gamera
+
+Submodules
+----------
+
+gamhelio.helioViz module
+------------------------
+
+.. automodule:: gamhelio.helioViz
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gamhelio.heliosphere module
+---------------------------
+
+.. automodule:: gamhelio.heliosphere
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: gamhelio
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/gamhelio.wsa2TDgamera.rst.txt

@@ -0,0 +1,21 @@
+gamhelio.wsa2TDgamera package
+=============================
+
+Submodules
+----------
+
+gamhelio.wsa2TDgamera.params module
+-----------------------------------
+
+.. automodule:: gamhelio.wsa2TDgamera.params
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: gamhelio.wsa2TDgamera
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/gamhelio.wsa2gamera.rst.txt

@@ -0,0 +1,21 @@
+gamhelio.wsa2gamera package
+===========================
+
+Submodules
+----------
+
+gamhelio.wsa2gamera.params module
+---------------------------------
+
+.. automodule:: gamhelio.wsa2gamera.params
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: gamhelio.wsa2gamera
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/index.rst.txt

@@ -0,0 +1,24 @@
+.. Kaipy documentation master file, created by
+   sphinx-quickstart on Tue Jun 11 18:09:20 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Kaipy documentation!
+=================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+   
+   intro
+   modules
+
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/build/html/_sources/intro.rst.txt

@@ -0,0 +1,4 @@
+Introduction
+============
+
+``kaipy`` is a Python package for supporting the running and analysis of the Mutliscale Atmosphere Geospace Environment (MAGE) Model developed by the Center for Geospace Storms.

docs/build/html/_sources/kJobs.rst.txt

@@ -0,0 +1,7 @@
+kJobs module
+============
+
+.. automodule:: kJobs
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/kaiH5.rst.txt

@@ -0,0 +1,7 @@
+kaiH5 module
+============
+
+.. automodule:: kaiH5
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/kaiTools.rst.txt

@@ -0,0 +1,7 @@
+kaiTools module
+===============
+
+.. automodule:: kaiTools
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/kaiViz.rst.txt

@@ -0,0 +1,7 @@
+kaiViz module
+=============
+
+.. automodule:: kaiViz
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/kaijson.rst.txt

@@ -0,0 +1,7 @@
+kaijson module
+==============
+
+.. automodule:: kaijson
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/kaixdmf.rst.txt

@@ -0,0 +1,7 @@
+kaixdmf module
+==============
+
+.. automodule:: kaixdmf
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/kdefs.rst.txt

@@ -0,0 +1,7 @@
+kdefs module
+============
+
+.. automodule:: kdefs
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/lfm2kaiju.rst.txt

@@ -0,0 +1,7 @@
+lfm2kaiju module
+================
+
+.. automodule:: lfm2kaiju
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/modules.rst.txt

@@ -0,0 +1,26 @@
+kaipy
+=====
+
+.. toctree::
+   :maxdepth: 4
+
+   cdaweb_utils
+   chimp
+   embiggenUtils
+   gamera
+   gamhelio
+   kJobs
+   kaiH5
+   kaiTools
+   kaiViz
+   kaijson
+   kaixdmf
+   kdefs
+   lfm2kaiju
+   paraview
+   rcm
+   remix
+   solarWind
+   supermag_api
+   supermage
+   transform

docs/build/html/_sources/paraview.rst.txt

@@ -0,0 +1,29 @@
+paraview package
+================
+
+Submodules
+----------
+
+paraview.pvGam module
+---------------------
+
+.. automodule:: paraview.pvGam
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+paraview.pvutils module
+-----------------------
+
+.. automodule:: paraview.pvutils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: paraview
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/rcm.lambdautils.rst.txt

@@ -0,0 +1,61 @@
+rcm.lambdautils package
+=======================
+
+Submodules
+----------
+
+rcm.lambdautils.AlamData module
+-------------------------------
+
+.. automodule:: rcm.lambdautils.AlamData
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rcm.lambdautils.AlamParams module
+---------------------------------
+
+.. automodule:: rcm.lambdautils.AlamParams
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rcm.lambdautils.DistTypes module
+--------------------------------
+
+.. automodule:: rcm.lambdautils.DistTypes
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rcm.lambdautils.fileIO module
+-----------------------------
+
+.. automodule:: rcm.lambdautils.fileIO
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rcm.lambdautils.genAlam module
+------------------------------
+
+.. automodule:: rcm.lambdautils.genAlam
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rcm.lambdautils.plotter module
+------------------------------
+
+.. automodule:: rcm.lambdautils.plotter
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: rcm.lambdautils
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/rcm.rst.txt

@@ -0,0 +1,46 @@
+rcm package
+===========
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   rcm.lambdautils
+   rcm.wmutils
+
+Submodules
+----------
+
+rcm.rcminit module
+------------------
+
+.. automodule:: rcm.rcminit
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rcm.rcmutils module
+-------------------
+
+.. automodule:: rcm.rcmutils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rcm.rcmxdmf module
+------------------
+
+.. automodule:: rcm.rcmxdmf
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: rcm
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/rcm.wmutils.rst.txt

@@ -0,0 +1,29 @@
+rcm.wmutils package
+===================
+
+Submodules
+----------
+
+rcm.wmutils.genWM module
+------------------------
+
+.. automodule:: rcm.wmutils.genWM
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rcm.wmutils.wmData module
+-------------------------
+
+.. automodule:: rcm.wmutils.wmData
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: rcm.wmutils
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/remix.rst.txt

@@ -0,0 +1,21 @@
+remix package
+=============
+
+Submodules
+----------
+
+remix.remix module
+------------------
+
+.. automodule:: remix.remix
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: remix
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/solarWind.rst.txt

@@ -0,0 +1,77 @@
+solarWind package
+=================
+
+Submodules
+----------
+
+solarWind.CUSTOM module
+-----------------------
+
+.. automodule:: solarWind.CUSTOM
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+solarWind.OMNI module
+---------------------
+
+.. automodule:: solarWind.OMNI
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+solarWind.SolarWind module
+--------------------------
+
+.. automodule:: solarWind.SolarWind
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+solarWind.TimeSeries module
+---------------------------
+
+.. automodule:: solarWind.TimeSeries
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+solarWind.WIND module
+---------------------
+
+.. automodule:: solarWind.WIND
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+solarWind.jdutil module
+-----------------------
+
+.. automodule:: solarWind.jdutil
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+solarWind.ols module
+--------------------
+
+.. automodule:: solarWind.ols
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+solarWind.swBCplots module
+--------------------------
+
+.. automodule:: solarWind.swBCplots
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: solarWind
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/supermag_api.rst.txt

@@ -0,0 +1,7 @@
+supermag\_api module
+====================
+
+.. automodule:: supermag_api
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/supermage.rst.txt

@@ -0,0 +1,7 @@
+supermage module
+================
+
+.. automodule:: supermage
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/transform.rst.txt

@@ -0,0 +1,7 @@
+transform module
+================
+
+.. automodule:: transform
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_static/_sphinx_javascript_frameworks_compat.js

@@ -0,0 +1,123 @@
+/* Compatability shim for jQuery and underscores.js.
+ *
+ * Copyright Sphinx contributors
+ * Released under the two clause BSD licence
+ */
+
+/**
+ * small helper function to urldecode strings
+ *
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
+ */
+jQuery.urldecode = function(x) {
+    if (!x) {
+        return x
+    }
+    return decodeURIComponent(x.replace(/\+/g, ' '));
+};
+
+/**
+ * small helper function to urlencode strings
+ */
+jQuery.urlencode = encodeURIComponent;
+
+/**
+ * This function returns the parsed url parameters of the
+ * current request. Multiple values per key are supported,
+ * it will always return arrays of strings for the value parts.
+ */
+jQuery.getQueryParameters = function(s) {
+    if (typeof s === 'undefined')
+        s = document.location.search;
+    var parts = s.substr(s.indexOf('?') + 1).split('&');
+    var result = {};
+    for (var i = 0; i < parts.length; i++) {
+        var tmp = parts[i].split('=', 2);
+        var key = jQuery.urldecode(tmp[0]);
+        var value = jQuery.urldecode(tmp[1]);
+        if (key in result)
+            result[key].push(value);
+        else
+            result[key] = [value];
+    }
+    return result;
+};
+
+/**
+ * highlight a given string on a jquery object by wrapping it in
+ * span elements with the given class name.
+ */
+jQuery.fn.highlightText = function(text, className) {
+    function highlight(node, addItems) {
+        if (node.nodeType === 3) {
+            var val = node.nodeValue;
+            var pos = val.toLowerCase().indexOf(text);
+            if (pos >= 0 &&
+                !jQuery(node.parentNode).hasClass(className) &&
+                !jQuery(node.parentNode).hasClass("nohighlight")) {
+                var span;
+                var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
+                if (isInSVG) {
+                    span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+                } else {
+                    span = document.createElement("span");
+                    span.className = className;
+                }
+                span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+                node.parentNode.insertBefore(span, node.parentNode.insertBefore(
+                    document.createTextNode(val.substr(pos + text.length)),
+                    node.nextSibling));
+                node.nodeValue = val.substr(0, pos);
+                if (isInSVG) {
+                    var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
+                    var bbox = node.parentElement.getBBox();
+                    rect.x.baseVal.value = bbox.x;
+                    rect.y.baseVal.value = bbox.y;
+                    rect.width.baseVal.value = bbox.width;
+                    rect.height.baseVal.value = bbox.height;
+                    rect.setAttribute('class', className);
+                    addItems.push({
+                        "parent": node.parentNode,
+                        "target": rect});
+                }
+            }
+        }
+        else if (!jQuery(node).is("button, select, textarea")) {
+            jQuery.each(node.childNodes, function() {
+                highlight(this, addItems);
+            });
+        }
+    }
+    var addItems = [];
+    var result = this.each(function() {
+        highlight(this, addItems);
+    });
+    for (var i = 0; i < addItems.length; ++i) {
+        jQuery(addItems[i].parent).before(addItems[i].target);
+    }
+    return result;
+};
+
+/*
+ * backward compatibility for jQuery.browser
+ * This will be supported until firefox bug is fixed.
+ */
+if (!jQuery.browser) {
+    jQuery.uaMatch = function(ua) {
+        ua = ua.toLowerCase();
+
+        var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
+            /(webkit)[ \/]([\w.]+)/.exec(ua) ||
+            /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
+            /(msie) ([\w.]+)/.exec(ua) ||
+            ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
+            [];
+
+        return {
+            browser: match[ 1 ] || "",
+            version: match[ 2 ] || "0"
+        };
+    };
+    jQuery.browser = {};
+    jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
+}

docs/build/html/_static/basic.css

@@ -0,0 +1,903 @@
+/*
+ * basic.css
+ * ~~~~~~~~~
+ *
+ * Sphinx stylesheet -- basic theme.
+ *
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+/* -- main layout ----------------------------------------------------------- */
+
+div.clearer {
+    clear: both;
+}
+
+div.section::after {
+    display: block;
+    content: '';
+    clear: left;
+}
+
+/* -- relbar ---------------------------------------------------------------- */
+
+div.related {
+    width: 100%;
+    font-size: 90%;
+}
+
+div.related h3 {
+    display: none;
+}
+
+div.related ul {
+    margin: 0;
+    padding: 0 0 0 10px;
+    list-style: none;
+}
+
+div.related li {
+    display: inline;
+}
+
+div.related li.right {
+    float: right;
+    margin-right: 5px;
+}
+
+/* -- sidebar --------------------------------------------------------------- */
+
+div.sphinxsidebarwrapper {
+    padding: 10px 5px 0 10px;
+}
+
+div.sphinxsidebar {
+    float: left;
+    width: 230px;
+    margin-left: -100%;
+    font-size: 90%;
+    word-wrap: break-word;
+    overflow-wrap : break-word;
+}
+
+div.sphinxsidebar ul {
+    list-style: none;
+}
+
+div.sphinxsidebar ul ul,
+div.sphinxsidebar ul.want-points {
+    margin-left: 20px;
+    list-style: square;
+}
+
+div.sphinxsidebar ul ul {
+    margin-top: 0;
+    margin-bottom: 0;
+}
+
+div.sphinxsidebar form {
+    margin-top: 10px;
+}
+
+div.sphinxsidebar input {
+    border: 1px solid #98dbcc;
+    font-family: sans-serif;
+    font-size: 1em;
+}
+
+div.sphinxsidebar #searchbox form.search {
+    overflow: hidden;
+}
+
+div.sphinxsidebar #searchbox input[type="text"] {
+    float: left;
+    width: 80%;
+    padding: 0.25em;
+    box-sizing: border-box;
+}
+
+div.sphinxsidebar #searchbox input[type="submit"] {
+    float: left;
+    width: 20%;
+    border-left: none;
+    padding: 0.25em;
+    box-sizing: border-box;
+}
+
+
+img {
+    border: 0;
+    max-width: 100%;
+}
+
+/* -- search page ----------------------------------------------------------- */
+
+ul.search {
+    margin: 10px 0 0 20px;
+    padding: 0;
+}
+
+ul.search li {
+    padding: 5px 0 5px 20px;
+    background-image: url(file.png);
+    background-repeat: no-repeat;
+    background-position: 0 7px;
+}
+
+ul.search li a {
+    font-weight: bold;
+}
+
+ul.search li p.context {
+    color: #888;
+    margin: 2px 0 0 30px;
+    text-align: left;
+}
+
+ul.keywordmatches li.goodmatch a {
+    font-weight: bold;
+}
+
+/* -- index page ------------------------------------------------------------ */
+
+table.contentstable {
+    width: 90%;
+    margin-left: auto;
+    margin-right: auto;
+}
+
+table.contentstable p.biglink {
+    line-height: 150%;
+}
+
+a.biglink {
+    font-size: 1.3em;
+}
+
+span.linkdescr {
+    font-style: italic;
+    padding-top: 5px;
+    font-size: 90%;
+}
+
+/* -- general index --------------------------------------------------------- */
+
+table.indextable {
+    width: 100%;
+}
+
+table.indextable td {
+    text-align: left;
+    vertical-align: top;
+}
+
+table.indextable ul {
+    margin-top: 0;
+    margin-bottom: 0;
+    list-style-type: none;
+}
+
+table.indextable > tbody > tr > td > ul {
+    padding-left: 0em;
+}
+
+table.indextable tr.pcap {
+    height: 10px;
+}
+
+table.indextable tr.cap {
+    margin-top: 10px;
+    background-color: #f2f2f2;
+}
+
+img.toggler {
+    margin-right: 3px;
+    margin-top: 3px;
+    cursor: pointer;
+}
+
+div.modindex-jumpbox {
+    border-top: 1px solid #ddd;
+    border-bottom: 1px solid #ddd;
+    margin: 1em 0 1em 0;
+    padding: 0.4em;
+}
+
+div.genindex-jumpbox {
+    border-top: 1px solid #ddd;
+    border-bottom: 1px solid #ddd;
+    margin: 1em 0 1em 0;
+    padding: 0.4em;
+}
+
+/* -- domain module index --------------------------------------------------- */
+
+table.modindextable td {
+    padding: 2px;
+    border-collapse: collapse;
+}
+
+/* -- general body styles --------------------------------------------------- */
+
+div.body {
+    min-width: 360px;
+    max-width: 800px;
+}
+
+div.body p, div.body dd, div.body li, div.body blockquote {
+    -moz-hyphens: auto;
+    -ms-hyphens: auto;
+    -webkit-hyphens: auto;
+    hyphens: auto;
+}
+
+a.headerlink {
+    visibility: hidden;
+}
+
+h1:hover > a.headerlink,
+h2:hover > a.headerlink,
+h3:hover > a.headerlink,
+h4:hover > a.headerlink,
+h5:hover > a.headerlink,
+h6:hover > a.headerlink,
+dt:hover > a.headerlink,
+caption:hover > a.headerlink,
+p.caption:hover > a.headerlink,
+div.code-block-caption:hover > a.headerlink {
+    visibility: visible;
+}
+
+div.body p.caption {
+    text-align: inherit;
+}
+
+div.body td {
+    text-align: left;
+}
+
+.first {
+    margin-top: 0 !important;
+}
+
+p.rubric {
+    margin-top: 30px;
+    font-weight: bold;
+}
+
+img.align-left, figure.align-left, .figure.align-left, object.align-left {
+    clear: left;
+    float: left;
+    margin-right: 1em;
+}
+
+img.align-right, figure.align-right, .figure.align-right, object.align-right {
+    clear: right;
+    float: right;
+    margin-left: 1em;
+}
+
+img.align-center, figure.align-center, .figure.align-center, object.align-center {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+}
+
+img.align-default, figure.align-default, .figure.align-default {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+}
+
+.align-left {
+    text-align: left;
+}
+
+.align-center {
+    text-align: center;
+}
+
+.align-default {
+    text-align: center;
+}
+
+.align-right {
+    text-align: right;
+}
+
+/* -- sidebars -------------------------------------------------------------- */
+
+div.sidebar,
+aside.sidebar {
+    margin: 0 0 0.5em 1em;
+    border: 1px solid #ddb;
+    padding: 7px;
+    background-color: #ffe;
+    width: 40%;
+    float: right;
+    clear: right;
+    overflow-x: auto;
+}
+
+p.sidebar-title {
+    font-weight: bold;
+}
+
+nav.contents,
+aside.topic,
+div.admonition, div.topic, blockquote {
+    clear: left;
+}
+
+/* -- topics ---------------------------------------------------------------- */
+
+nav.contents,
+aside.topic,
+div.topic {
+    border: 1px solid #ccc;
+    padding: 7px;
+    margin: 10px 0 10px 0;
+}
+
+p.topic-title {
+    font-size: 1.1em;
+    font-weight: bold;
+    margin-top: 10px;
+}
+
+/* -- admonitions ----------------------------------------------------------- */
+
+div.admonition {
+    margin-top: 10px;
+    margin-bottom: 10px;
+    padding: 7px;
+}
+
+div.admonition dt {
+    font-weight: bold;
+}
+
+p.admonition-title {
+    margin: 0px 10px 5px 0px;
+    font-weight: bold;
+}
+
+div.body p.centered {
+    text-align: center;
+    margin-top: 25px;
+}
+
+/* -- content of sidebars/topics/admonitions -------------------------------- */
+
+div.sidebar > :last-child,
+aside.sidebar > :last-child,
+nav.contents > :last-child,
+aside.topic > :last-child,
+div.topic > :last-child,
+div.admonition > :last-child {
+    margin-bottom: 0;
+}
+
+div.sidebar::after,
+aside.sidebar::after,
+nav.contents::after,
+aside.topic::after,
+div.topic::after,
+div.admonition::after,
+blockquote::after {
+    display: block;
+    content: '';
+    clear: both;
+}
+
+/* -- tables ---------------------------------------------------------------- */
+
+table.docutils {
+    margin-top: 10px;
+    margin-bottom: 10px;
+    border: 0;
+    border-collapse: collapse;
+}
+
+table.align-center {
+    margin-left: auto;
+    margin-right: auto;
+}
+
+table.align-default {
+    margin-left: auto;
+    margin-right: auto;
+}
+
+table caption span.caption-number {
+    font-style: italic;
+}
+
+table caption span.caption-text {
+}
+
+table.docutils td, table.docutils th {
+    padding: 1px 8px 1px 5px;
+    border-top: 0;
+    border-left: 0;
+    border-right: 0;
+    border-bottom: 1px solid #aaa;
+}
+
+th {
+    text-align: left;
+    padding-right: 5px;
+}
+
+table.citation {
+    border-left: solid 1px gray;
+    margin-left: 1px;
+}
+
+table.citation td {
+    border-bottom: none;
+}
+
+th > :first-child,
+td > :first-child {
+    margin-top: 0px;
+}
+
+th > :last-child,
+td > :last-child {
+    margin-bottom: 0px;
+}
+
+/* -- figures --------------------------------------------------------------- */
+
+div.figure, figure {
+    margin: 0.5em;
+    padding: 0.5em;
+}
+
+div.figure p.caption, figcaption {
+    padding: 0.3em;
+}
+
+div.figure p.caption span.caption-number,
+figcaption span.caption-number {
+    font-style: italic;
+}
+
+div.figure p.caption span.caption-text,
+figcaption span.caption-text {
+}
+
+/* -- field list styles ----------------------------------------------------- */
+
+table.field-list td, table.field-list th {
+    border: 0 !important;
+}
+
+.field-list ul {
+    margin: 0;
+    padding-left: 1em;
+}
+
+.field-list p {
+    margin: 0;
+}
+
+.field-name {
+    -moz-hyphens: manual;
+    -ms-hyphens: manual;
+    -webkit-hyphens: manual;
+    hyphens: manual;
+}
+
+/* -- hlist styles ---------------------------------------------------------- */
+
+table.hlist {
+    margin: 1em 0;
+}
+
+table.hlist td {
+    vertical-align: top;
+}
+
+/* -- object description styles --------------------------------------------- */
+
+.sig {
+	font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
+}
+
+.sig-name, code.descname {
+    background-color: transparent;
+    font-weight: bold;
+}
+
+.sig-name {
+	font-size: 1.1em;
+}
+
+code.descname {
+    font-size: 1.2em;
+}
+
+.sig-prename, code.descclassname {
+    background-color: transparent;
+}
+
+.optional {
+    font-size: 1.3em;
+}
+
+.sig-paren {
+    font-size: larger;
+}
+
+.sig-param.n {
+	font-style: italic;
+}
+
+/* C++ specific styling */
+
+.sig-inline.c-texpr,
+.sig-inline.cpp-texpr {
+	font-family: unset;
+}
+
+.sig.c   .k, .sig.c   .kt,
+.sig.cpp .k, .sig.cpp .kt {
+	color: #0033B3;
+}
+
+.sig.c   .m,
+.sig.cpp .m {
+	color: #1750EB;
+}
+
+.sig.c   .s, .sig.c   .sc,
+.sig.cpp .s, .sig.cpp .sc {
+	color: #067D17;
+}
+
+
+/* -- other body styles ----------------------------------------------------- */
+
+ol.arabic {
+    list-style: decimal;
+}
+
+ol.loweralpha {
+    list-style: lower-alpha;
+}
+
+ol.upperalpha {
+    list-style: upper-alpha;
+}
+
+ol.lowerroman {
+    list-style: lower-roman;
+}
+
+ol.upperroman {
+    list-style: upper-roman;
+}
+
+:not(li) > ol > li:first-child > :first-child,
+:not(li) > ul > li:first-child > :first-child {
+    margin-top: 0px;
+}
+
+:not(li) > ol > li:last-child > :last-child,
+:not(li) > ul > li:last-child > :last-child {
+    margin-bottom: 0px;
+}
+
+ol.simple ol p,
+ol.simple ul p,
+ul.simple ol p,
+ul.simple ul p {
+    margin-top: 0;
+}
+
+ol.simple > li:not(:first-child) > p,
+ul.simple > li:not(:first-child) > p {
+    margin-top: 0;
+}
+
+ol.simple p,
+ul.simple p {
+    margin-bottom: 0;
+}
+
+aside.footnote > span,
+div.citation > span {
+    float: left;
+}
+aside.footnote > span:last-of-type,
+div.citation > span:last-of-type {
+  padding-right: 0.5em;
+}
+aside.footnote > p {
+  margin-left: 2em;
+}
+div.citation > p {
+  margin-left: 4em;
+}
+aside.footnote > p:last-of-type,
+div.citation > p:last-of-type {
+    margin-bottom: 0em;
+}
+aside.footnote > p:last-of-type:after,
+div.citation > p:last-of-type:after {
+    content: "";
+    clear: both;
+}
+
+dl.field-list {
+    display: grid;
+    grid-template-columns: fit-content(30%) auto;
+}
+
+dl.field-list > dt {
+    font-weight: bold;
+    word-break: break-word;
+    padding-left: 0.5em;
+    padding-right: 5px;
+}
+
+dl.field-list > dd {
+    padding-left: 0.5em;
+    margin-top: 0em;
+    margin-left: 0em;
+    margin-bottom: 0em;
+}
+
+dl {
+    margin-bottom: 15px;
+}
+
+dd > :first-child {
+    margin-top: 0px;
+}
+
+dd ul, dd table {
+    margin-bottom: 10px;
+}
+
+dd {
+    margin-top: 3px;
+    margin-bottom: 10px;
+    margin-left: 30px;
+}
+
+dl > dd:last-child,
+dl > dd:last-child > :last-child {
+    margin-bottom: 0;
+}
+
+dt:target, span.highlighted {
+    background-color: #fbe54e;
+}
+
+rect.highlighted {
+    fill: #fbe54e;
+}
+
+dl.glossary dt {
+    font-weight: bold;
+    font-size: 1.1em;
+}
+
+.versionmodified {
+    font-style: italic;
+}
+
+.system-message {
+    background-color: #fda;
+    padding: 5px;
+    border: 3px solid red;
+}
+
+.footnote:target  {
+    background-color: #ffa;
+}
+
+.line-block {
+    display: block;
+    margin-top: 1em;
+    margin-bottom: 1em;
+}
+
+.line-block .line-block {
+    margin-top: 0;
+    margin-bottom: 0;
+    margin-left: 1.5em;
+}
+
+.guilabel, .menuselection {
+    font-family: sans-serif;
+}
+
+.accelerator {
+    text-decoration: underline;
+}
+
+.classifier {
+    font-style: oblique;
+}
+
+.classifier:before {
+    font-style: normal;
+    margin: 0 0.5em;
+    content: ":";
+    display: inline-block;
+}
+
+abbr, acronym {
+    border-bottom: dotted 1px;
+    cursor: help;
+}
+
+/* -- code displays --------------------------------------------------------- */
+
+pre {
+    overflow: auto;
+    overflow-y: hidden;  /* fixes display issues on Chrome browsers */
+}
+
+pre, div[class*="highlight-"] {
+    clear: both;
+}
+
+span.pre {
+    -moz-hyphens: none;
+    -ms-hyphens: none;
+    -webkit-hyphens: none;
+    hyphens: none;
+    white-space: nowrap;
+}
+
+div[class*="highlight-"] {
+    margin: 1em 0;
+}
+
+td.linenos pre {
+    border: 0;
+    background-color: transparent;
+    color: #aaa;
+}
+
+table.highlighttable {
+    display: block;
+}
+
+table.highlighttable tbody {
+    display: block;
+}
+
+table.highlighttable tr {
+    display: flex;
+}
+
+table.highlighttable td {
+    margin: 0;
+    padding: 0;
+}
+
+table.highlighttable td.linenos {
+    padding-right: 0.5em;
+}
+
+table.highlighttable td.code {
+    flex: 1;
+    overflow: hidden;
+}
+
+.highlight .hll {
+    display: block;
+}
+
+div.highlight pre,
+table.highlighttable pre {
+    margin: 0;
+}
+
+div.code-block-caption + div {
+    margin-top: 0;
+}
+
+div.code-block-caption {
+    margin-top: 1em;
+    padding: 2px 5px;
+    font-size: small;
+}
+
+div.code-block-caption code {
+    background-color: transparent;
+}
+
+table.highlighttable td.linenos,
+span.linenos,
+div.highlight span.gp {  /* gp: Generic.Prompt */
+  user-select: none;
+  -webkit-user-select: text; /* Safari fallback only */
+  -webkit-user-select: none; /* Chrome/Safari */
+  -moz-user-select: none; /* Firefox */
+  -ms-user-select: none; /* IE10+ */
+}
+
+div.code-block-caption span.caption-number {
+    padding: 0.1em 0.3em;
+    font-style: italic;
+}
+
+div.code-block-caption span.caption-text {
+}
+
+div.literal-block-wrapper {
+    margin: 1em 0;
+}
+
+code.xref, a code {
+    background-color: transparent;
+    font-weight: bold;
+}
+
+h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
+    background-color: transparent;
+}
+
+.viewcode-link {
+    float: right;
+}
+
+.viewcode-back {
+    float: right;
+    font-family: sans-serif;
+}
+
+div.viewcode-block:target {
+    margin: -1px -10px;
+    padding: 0 10px;
+}
+
+/* -- math display ---------------------------------------------------------- */
+
+img.math {
+    vertical-align: middle;
+}
+
+div.body div.math p {
+    text-align: center;
+}
+
+span.eqno {
+    float: right;
+}
+
+span.eqno a.headerlink {
+    position: absolute;
+    z-index: 1;
+}
+
+div.math:hover a.headerlink {
+    visibility: visible;
+}
+
+/* -- printout stylesheet --------------------------------------------------- */
+
+@media print {
+    div.document,
+    div.documentwrapper,
+    div.bodywrapper {
+        margin: 0 !important;
+        width: 100%;
+    }
+
+    div.sphinxsidebar,
+    div.related,
+    div.footer,
+    #top-link {
+        display: none;
+    }
+}

docs/build/html/_static/css/badge_only.css

@@ -0,0 +1 @@
+.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}

docs/build/html/_static/doctools.js

@@ -0,0 +1,156 @@
+/*
+ * doctools.js
+ * ~~~~~~~~~~~
+ *
+ * Base JavaScript utilities for all Sphinx HTML documentation.
+ *
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+"use strict";
+
+const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([
+  "TEXTAREA",
+  "INPUT",
+  "SELECT",
+  "BUTTON",
+]);
+
+const _ready = (callback) => {
+  if (document.readyState !== "loading") {
+    callback();
+  } else {
+    document.addEventListener("DOMContentLoaded", callback);
+  }
+};
+
+/**
+ * Small JavaScript module for the documentation.
+ */
+const Documentation = {
+  init: () => {
+    Documentation.initDomainIndexTable();
+    Documentation.initOnKeyListeners();
+  },
+
+  /**
+   * i18n support
+   */
+  TRANSLATIONS: {},
+  PLURAL_EXPR: (n) => (n === 1 ? 0 : 1),
+  LOCALE: "unknown",
+
+  // gettext and ngettext don't access this so that the functions
+  // can safely bound to a different name (_ = Documentation.gettext)
+  gettext: (string) => {
+    const translated = Documentation.TRANSLATIONS[string];
+    switch (typeof translated) {
+      case "undefined":
+        return string; // no translation
+      case "string":
+        return translated; // translation exists
+      default:
+        return translated[0]; // (singular, plural) translation tuple exists
+    }
+  },
+
+  ngettext: (singular, plural, n) => {
+    const translated = Documentation.TRANSLATIONS[singular];
+    if (typeof translated !== "undefined")
+      return translated[Documentation.PLURAL_EXPR(n)];
+    return n === 1 ? singular : plural;
+  },
+
+  addTranslations: (catalog) => {
+    Object.assign(Documentation.TRANSLATIONS, catalog.messages);
+    Documentation.PLURAL_EXPR = new Function(
+      "n",
+      `return (${catalog.plural_expr})`
+    );
+    Documentation.LOCALE = catalog.locale;
+  },
+
+  /**
+   * helper function to focus on search bar
+   */
+  focusSearchBar: () => {
+    document.querySelectorAll("input[name=q]")[0]?.focus();
+  },
+
+  /**
+   * Initialise the domain index toggle buttons
+   */
+  initDomainIndexTable: () => {
+    const toggler = (el) => {
+      const idNumber = el.id.substr(7);
+      const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`);
+      if (el.src.substr(-9) === "minus.png") {
+        el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`;
+        toggledRows.forEach((el) => (el.style.display = "none"));
+      } else {
+        el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`;
+        toggledRows.forEach((el) => (el.style.display = ""));
+      }
+    };
+
+    const togglerElements = document.querySelectorAll("img.toggler");
+    togglerElements.forEach((el) =>
+      el.addEventListener("click", (event) => toggler(event.currentTarget))
+    );
+    togglerElements.forEach((el) => (el.style.display = ""));
+    if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler);
+  },
+
+  initOnKeyListeners: () => {
+    // only install a listener if it is really needed
+    if (
+      !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
+      !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS
+    )
+      return;
+
+    document.addEventListener("keydown", (event) => {
+      // bail for input elements
+      if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
+      // bail with special keys
+      if (event.altKey || event.ctrlKey || event.metaKey) return;
+
+      if (!event.shiftKey) {
+        switch (event.key) {
+          case "ArrowLeft":
+            if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
+
+            const prevLink = document.querySelector('link[rel="prev"]');
+            if (prevLink && prevLink.href) {
+              window.location.href = prevLink.href;
+              event.preventDefault();
+            }
+            break;
+          case "ArrowRight":
+            if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
+
+            const nextLink = document.querySelector('link[rel="next"]');
+            if (nextLink && nextLink.href) {
+              window.location.href = nextLink.href;
+              event.preventDefault();
+            }
+            break;
+        }
+      }
+
+      // some keyboard layouts may need Shift to get /
+      switch (event.key) {
+        case "/":
+          if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break;
+          Documentation.focusSearchBar();
+          event.preventDefault();
+      }
+    });
+  },
+};
+
+// quick alias for translations
+const _ = Documentation.gettext;
+
+_ready(Documentation.init);

docs/build/html/_static/documentation_options.js

@@ -0,0 +1,14 @@
+var DOCUMENTATION_OPTIONS = {
+    URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
+    VERSION: '1.0.0',
+    LANGUAGE: 'en',
+    COLLAPSE_INDEX: false,
+    BUILDER: 'html',
+    FILE_SUFFIX: '.html',
+    LINK_SUFFIX: '.html',
+    HAS_SOURCE: true,
+    SOURCELINK_SUFFIX: '.txt',
+    NAVIGATION_WITH_KEYS: false,
+    SHOW_SEARCH_SUMMARY: true,
+    ENABLE_SEARCH_SHORTCUTS: true,
+};

docs/build/html/_static/js/badge_only.js

@@ -0,0 +1 @@
+!function(e){var t={};function r(n){if(t[n])return t[n].exports;var o=t[n]={i:n,l:!1,exports:{}};return e[n].call(o.exports,o,o.exports,r),o.l=!0,o.exports}r.m=e,r.c=t,r.d=function(e,t,n){r.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:n})},r.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.t=function(e,t){if(1&t&&(e=r(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var n=Object.create(null);if(r.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var o in e)r.d(n,o,function(t){return e[t]}.bind(null,o));return n},r.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return r.d(t,"a",t),t},r.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},r.p="",r(r.s=4)}({4:function(e,t,r){}});

docs/build/html/_static/js/html5shiv-printshiv.min.js

@@ -0,0 +1,4 @@
+/**
+* @preserve HTML5 Shiv 3.7.3-pre | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed
+*/
+!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x<style>"+b+"</style>",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=y.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=y.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),y.elements=c+" "+a,j(b)}function f(a){var b=x[a[v]];return b||(b={},w++,a[v]=w,x[w]=b),b}function g(a,c,d){if(c||(c=b),q)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():u.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||t.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),q)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return y.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(y,b.frag)}function j(a){a||(a=b);var d=f(a);return!y.shivCSS||p||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),q||i(a,d),a}function k(a){for(var b,c=a.getElementsByTagName("*"),e=c.length,f=RegExp("^(?:"+d().join("|")+")$","i"),g=[];e--;)b=c[e],f.test(b.nodeName)&&g.push(b.applyElement(l(b)));return g}function l(a){for(var b,c=a.attributes,d=c.length,e=a.ownerDocument.createElement(A+":"+a.nodeName);d--;)b=c[d],b.specified&&e.setAttribute(b.nodeName,b.nodeValue);return e.style.cssText=a.style.cssText,e}function m(a){for(var b,c=a.split("{"),e=c.length,f=RegExp("(^|[\\s,>+~])("+d().join("|")+")(?=[[\\s,>+~#.:]|$)","gi"),g="$1"+A+"\\:$2";e--;)b=c[e]=c[e].split("}"),b[b.length-1]=b[b.length-1].replace(f,g),c[e]=b.join("}");return c.join("{")}function n(a){for(var b=a.length;b--;)a[b].removeNode()}function o(a){function b(){clearTimeout(g._removeSheetTimer),d&&d.removeNode(!0),d=null}var d,e,g=f(a),h=a.namespaces,i=a.parentWindow;return!B||a.printShived?a:("undefined"==typeof h[A]&&h.add(A),i.attachEvent("onbeforeprint",function(){b();for(var f,g,h,i=a.styleSheets,j=[],l=i.length,n=Array(l);l--;)n[l]=i[l];for(;h=n.pop();)if(!h.disabled&&z.test(h.media)){try{f=h.imports,g=f.length}catch(o){g=0}for(l=0;g>l;l++)n.push(f[l]);try{j.push(h.cssText)}catch(o){}}j=m(j.reverse().join("")),e=k(a),d=c(a,j)}),i.attachEvent("onafterprint",function(){n(e),clearTimeout(g._removeSheetTimer),g._removeSheetTimer=setTimeout(b,500)}),a.printShived=!0,a)}var p,q,r="3.7.3",s=a.html5||{},t=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,u=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,v="_html5shiv",w=0,x={};!function(){try{var a=b.createElement("a");a.innerHTML="<xyz></xyz>",p="hidden"in a,q=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){p=!0,q=!0}}();var y={elements:s.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:r,shivCSS:s.shivCSS!==!1,supportsUnknownElements:q,shivMethods:s.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=y,j(b);var z=/^$|\b(?:all|print)\b/,A="html5shiv",B=!q&&function(){var c=b.documentElement;return!("undefined"==typeof b.namespaces||"undefined"==typeof b.parentWindow||"undefined"==typeof c.applyElement||"undefined"==typeof c.removeNode||"undefined"==typeof a.attachEvent)}();y.type+=" print",y.shivPrint=o,o(b),"object"==typeof module&&module.exports&&(module.exports=y)}("undefined"!=typeof window?window:this,document);

docs/build/html/_static/js/html5shiv.min.js

@@ -0,0 +1,4 @@
+/**
+* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed
+*/
+!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x<style>"+b+"</style>",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3-pre",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="<xyz></xyz>",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document);

docs/build/html/_static/language_data.js

@@ -0,0 +1,199 @@
+/*
+ * language_data.js
+ * ~~~~~~~~~~~~~~~~
+ *
+ * This script contains the language-specific data used by searchtools.js,
+ * namely the list of stopwords, stemmer, scorer and splitter.
+ *
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];
+
+
+/* Non-minified version is copied as a separate JS file, is available */
+
+/**
+ * Porter Stemmer
+ */
+var Stemmer = function() {
+
+  var step2list = {
+    ational: 'ate',
+    tional: 'tion',
+    enci: 'ence',
+    anci: 'ance',
+    izer: 'ize',
+    bli: 'ble',
+    alli: 'al',
+    entli: 'ent',
+    eli: 'e',
+    ousli: 'ous',
+    ization: 'ize',
+    ation: 'ate',
+    ator: 'ate',
+    alism: 'al',
+    iveness: 'ive',
+    fulness: 'ful',
+    ousness: 'ous',
+    aliti: 'al',
+    iviti: 'ive',
+    biliti: 'ble',
+    logi: 'log'
+  };
+
+  var step3list = {
+    icate: 'ic',
+    ative: '',
+    alize: 'al',
+    iciti: 'ic',
+    ical: 'ic',
+    ful: '',
+    ness: ''
+  };
+
+  var c = "[^aeiou]";          // consonant
+  var v = "[aeiouy]";          // vowel
+  var C = c + "[^aeiouy]*";    // consonant sequence
+  var V = v + "[aeiou]*";      // vowel sequence
+
+  var mgr0 = "^(" + C + ")?" + V + C;                      // [C]VC... is m>0
+  var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$";    // [C]VC[V] is m=1
+  var mgr1 = "^(" + C + ")?" + V + C + V + C;              // [C]VCVC... is m>1
+  var s_v   = "^(" + C + ")?" + v;                         // vowel in stem
+
+  this.stemWord = function (w) {
+    var stem;
+    var suffix;
+    var firstch;
+    var origword = w;
+
+    if (w.length < 3)
+      return w;
+
+    var re;
+    var re2;
+    var re3;
+    var re4;
+
+    firstch = w.substr(0,1);
+    if (firstch == "y")
+      w = firstch.toUpperCase() + w.substr(1);
+
+    // Step 1a
+    re = /^(.+?)(ss|i)es$/;
+    re2 = /^(.+?)([^s])s$/;
+
+    if (re.test(w))
+      w = w.replace(re,"$1$2");
+    else if (re2.test(w))
+      w = w.replace(re2,"$1$2");
+
+    // Step 1b
+    re = /^(.+?)eed$/;
+    re2 = /^(.+?)(ed|ing)$/;
+    if (re.test(w)) {
+      var fp = re.exec(w);
+      re = new RegExp(mgr0);
+      if (re.test(fp[1])) {
+        re = /.$/;
+        w = w.replace(re,"");
+      }
+    }
+    else if (re2.test(w)) {
+      var fp = re2.exec(w);
+      stem = fp[1];
+      re2 = new RegExp(s_v);
+      if (re2.test(stem)) {
+        w = stem;
+        re2 = /(at|bl|iz)$/;
+        re3 = new RegExp("([^aeiouylsz])\\1$");
+        re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+        if (re2.test(w))
+          w = w + "e";
+        else if (re3.test(w)) {
+          re = /.$/;
+          w = w.replace(re,"");
+        }
+        else if (re4.test(w))
+          w = w + "e";
+      }
+    }
+
+    // Step 1c
+    re = /^(.+?)y$/;
+    if (re.test(w)) {
+      var fp = re.exec(w);
+      stem = fp[1];
+      re = new RegExp(s_v);
+      if (re.test(stem))
+        w = stem + "i";
+    }
+
+    // Step 2
+    re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
+    if (re.test(w)) {
+      var fp = re.exec(w);
+      stem = fp[1];
+      suffix = fp[2];
+      re = new RegExp(mgr0);
+      if (re.test(stem))
+        w = stem + step2list[suffix];
+    }
+
+    // Step 3
+    re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
+    if (re.test(w)) {
+      var fp = re.exec(w);
+      stem = fp[1];
+      suffix = fp[2];
+      re = new RegExp(mgr0);
+      if (re.test(stem))
+        w = stem + step3list[suffix];
+    }
+
+    // Step 4
+    re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
+    re2 = /^(.+?)(s|t)(ion)$/;
+    if (re.test(w)) {
+      var fp = re.exec(w);
+      stem = fp[1];
+      re = new RegExp(mgr1);
+      if (re.test(stem))
+        w = stem;
+    }
+    else if (re2.test(w)) {
+      var fp = re2.exec(w);
+      stem = fp[1] + fp[2];
+      re2 = new RegExp(mgr1);
+      if (re2.test(stem))
+        w = stem;
+    }
+
+    // Step 5
+    re = /^(.+?)e$/;
+    if (re.test(w)) {
+      var fp = re.exec(w);
+      stem = fp[1];
+      re = new RegExp(mgr1);
+      re2 = new RegExp(meq1);
+      re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+      if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
+        w = stem;
+    }
+    re = /ll$/;
+    re2 = new RegExp(mgr1);
+    if (re.test(w) && re2.test(w)) {
+      re = /.$/;
+      w = w.replace(re,"");
+    }
+
+    // and turn initial Y back to y
+    if (firstch == "y")
+      w = firstch.toLowerCase() + w.substr(1);
+    return w;
+  }
+}
+

docs/build/html/_static/pygments.css

@@ -0,0 +1,75 @@
+pre { line-height: 125%; }
+td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
+span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
+td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
+span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
+.highlight .hll { background-color: #ffffcc }
+.highlight { background: #f8f8f8; }
+.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */
+.highlight .err { border: 1px solid #FF0000 } /* Error */
+.highlight .k { color: #008000; font-weight: bold } /* Keyword */
+.highlight .o { color: #666666 } /* Operator */
+.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */
+.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */
+.highlight .cp { color: #9C6500 } /* Comment.Preproc */
+.highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */
+.highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */
+.highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */
+.highlight .gd { color: #A00000 } /* Generic.Deleted */
+.highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
+.highlight .gr { color: #E40000 } /* Generic.Error */
+.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
+.highlight .gi { color: #008400 } /* Generic.Inserted */
+.highlight .go { color: #717171 } /* Generic.Output */
+.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
+.highlight .gs { font-weight: bold } /* Generic.Strong */
+.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
+.highlight .gt { color: #0044DD } /* Generic.Traceback */
+.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
+.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
+.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
+.highlight .kp { color: #008000 } /* Keyword.Pseudo */
+.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
+.highlight .kt { color: #B00040 } /* Keyword.Type */
+.highlight .m { color: #666666 } /* Literal.Number */
+.highlight .s { color: #BA2121 } /* Literal.String */
+.highlight .na { color: #687822 } /* Name.Attribute */
+.highlight .nb { color: #008000 } /* Name.Builtin */
+.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */
+.highlight .no { color: #880000 } /* Name.Constant */
+.highlight .nd { color: #AA22FF } /* Name.Decorator */
+.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */
+.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */
+.highlight .nf { color: #0000FF } /* Name.Function */
+.highlight .nl { color: #767600 } /* Name.Label */
+.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
+.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
+.highlight .nv { color: #19177C } /* Name.Variable */
+.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
+.highlight .w { color: #bbbbbb } /* Text.Whitespace */
+.highlight .mb { color: #666666 } /* Literal.Number.Bin */
+.highlight .mf { color: #666666 } /* Literal.Number.Float */
+.highlight .mh { color: #666666 } /* Literal.Number.Hex */
+.highlight .mi { color: #666666 } /* Literal.Number.Integer */
+.highlight .mo { color: #666666 } /* Literal.Number.Oct */
+.highlight .sa { color: #BA2121 } /* Literal.String.Affix */
+.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */
+.highlight .sc { color: #BA2121 } /* Literal.String.Char */
+.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */
+.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
+.highlight .s2 { color: #BA2121 } /* Literal.String.Double */
+.highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */
+.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */
+.highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */
+.highlight .sx { color: #008000 } /* Literal.String.Other */
+.highlight .sr { color: #A45A77 } /* Literal.String.Regex */
+.highlight .s1 { color: #BA2121 } /* Literal.String.Single */
+.highlight .ss { color: #19177C } /* Literal.String.Symbol */
+.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */
+.highlight .fm { color: #0000FF } /* Name.Function.Magic */
+.highlight .vc { color: #19177C } /* Name.Variable.Class */
+.highlight .vg { color: #19177C } /* Name.Variable.Global */
+.highlight .vi { color: #19177C } /* Name.Variable.Instance */
+.highlight .vm { color: #19177C } /* Name.Variable.Magic */
+.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */

docs/build/html/_static/searchtools.js

@@ -0,0 +1,566 @@
+/*
+ * searchtools.js
+ * ~~~~~~~~~~~~~~~~
+ *
+ * Sphinx JavaScript utilities for the full-text search.
+ *
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+"use strict";
+
+/**
+ * Simple result scoring code.
+ */
+if (typeof Scorer === "undefined") {
+  var Scorer = {
+    // Implement the following function to further tweak the score for each result
+    // The function takes a result array [docname, title, anchor, descr, score, filename]
+    // and returns the new score.
+    /*
+    score: result => {
+      const [docname, title, anchor, descr, score, filename] = result
+      return score
+    },
+    */
+
+    // query matches the full name of an object
+    objNameMatch: 11,
+    // or matches in the last dotted part of the object name
+    objPartialMatch: 6,
+    // Additive scores depending on the priority of the object
+    objPrio: {
+      0: 15, // used to be importantResults
+      1: 5, // used to be objectResults
+      2: -5, // used to be unimportantResults
+    },
+    //  Used when the priority is not in the mapping.
+    objPrioDefault: 0,
+
+    // query found in title
+    title: 15,
+    partialTitle: 7,
+    // query found in terms
+    term: 5,
+    partialTerm: 2,
+  };
+}
+
+const _removeChildren = (element) => {
+  while (element && element.lastChild) element.removeChild(element.lastChild);
+};
+
+/**
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping
+ */
+const _escapeRegExp = (string) =>
+  string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
+
+const _displayItem = (item, searchTerms) => {
+  const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
+  const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT;
+  const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
+  const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
+  const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
+
+  const [docName, title, anchor, descr, score, _filename] = item;
+
+  let listItem = document.createElement("li");
+  let requestUrl;
+  let linkUrl;
+  if (docBuilder === "dirhtml") {
+    // dirhtml builder
+    let dirname = docName + "/";
+    if (dirname.match(/\/index\/$/))
+      dirname = dirname.substring(0, dirname.length - 6);
+    else if (dirname === "index/") dirname = "";
+    requestUrl = docUrlRoot + dirname;
+    linkUrl = requestUrl;
+  } else {
+    // normal html builders
+    requestUrl = docUrlRoot + docName + docFileSuffix;
+    linkUrl = docName + docLinkSuffix;
+  }
+  let linkEl = listItem.appendChild(document.createElement("a"));
+  linkEl.href = linkUrl + anchor;
+  linkEl.dataset.score = score;
+  linkEl.innerHTML = title;
+  if (descr)
+    listItem.appendChild(document.createElement("span")).innerHTML =
+      " (" + descr + ")";
+  else if (showSearchSummary)
+    fetch(requestUrl)
+      .then((responseData) => responseData.text())
+      .then((data) => {
+        if (data)
+          listItem.appendChild(
+            Search.makeSearchSummary(data, searchTerms)
+          );
+      });
+  Search.output.appendChild(listItem);
+};
+const _finishSearch = (resultCount) => {
+  Search.stopPulse();
+  Search.title.innerText = _("Search Results");
+  if (!resultCount)
+    Search.status.innerText = Documentation.gettext(
+      "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories."
+    );
+  else
+    Search.status.innerText = _(
+      `Search finished, found ${resultCount} page(s) matching the search query.`
+    );
+};
+const _displayNextItem = (
+  results,
+  resultCount,
+  searchTerms
+) => {
+  // results left, load the summary and display it
+  // this is intended to be dynamic (don't sub resultsCount)
+  if (results.length) {
+    _displayItem(results.pop(), searchTerms);
+    setTimeout(
+      () => _displayNextItem(results, resultCount, searchTerms),
+      5
+    );
+  }
+  // search finished, update title and status message
+  else _finishSearch(resultCount);
+};
+
+/**
+ * Default splitQuery function. Can be overridden in ``sphinx.search`` with a
+ * custom function per language.
+ *
+ * The regular expression works by splitting the string on consecutive characters
+ * that are not Unicode letters, numbers, underscores, or emoji characters.
+ * This is the same as ``\W+`` in Python, preserving the surrogate pair area.
+ */
+if (typeof splitQuery === "undefined") {
+  var splitQuery = (query) => query
+      .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu)
+      .filter(term => term)  // remove remaining empty strings
+}
+
+/**
+ * Search Module
+ */
+const Search = {
+  _index: null,
+  _queued_query: null,
+  _pulse_status: -1,
+
+  htmlToText: (htmlString) => {
+    const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
+    htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() });
+    const docContent = htmlElement.querySelector('[role="main"]');
+    if (docContent !== undefined) return docContent.textContent;
+    console.warn(
+      "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template."
+    );
+    return "";
+  },
+
+  init: () => {
+    const query = new URLSearchParams(window.location.search).get("q");
+    document
+      .querySelectorAll('input[name="q"]')
+      .forEach((el) => (el.value = query));
+    if (query) Search.performSearch(query);
+  },
+
+  loadIndex: (url) =>
+    (document.body.appendChild(document.createElement("script")).src = url),
+
+  setIndex: (index) => {
+    Search._index = index;
+    if (Search._queued_query !== null) {
+      const query = Search._queued_query;
+      Search._queued_query = null;
+      Search.query(query);
+    }
+  },
+
+  hasIndex: () => Search._index !== null,
+
+  deferQuery: (query) => (Search._queued_query = query),
+
+  stopPulse: () => (Search._pulse_status = -1),
+
+  startPulse: () => {
+    if (Search._pulse_status >= 0) return;
+
+    const pulse = () => {
+      Search._pulse_status = (Search._pulse_status + 1) % 4;
+      Search.dots.innerText = ".".repeat(Search._pulse_status);
+      if (Search._pulse_status >= 0) window.setTimeout(pulse, 500);
+    };
+    pulse();
+  },
+
+  /**
+   * perform a search for something (or wait until index is loaded)
+   */
+  performSearch: (query) => {
+    // create the required interface elements
+    const searchText = document.createElement("h2");
+    searchText.textContent = _("Searching");
+    const searchSummary = document.createElement("p");
+    searchSummary.classList.add("search-summary");
+    searchSummary.innerText = "";
+    const searchList = document.createElement("ul");
+    searchList.classList.add("search");
+
+    const out = document.getElementById("search-results");
+    Search.title = out.appendChild(searchText);
+    Search.dots = Search.title.appendChild(document.createElement("span"));
+    Search.status = out.appendChild(searchSummary);
+    Search.output = out.appendChild(searchList);
+
+    const searchProgress = document.getElementById("search-progress");
+    // Some themes don't use the search progress node
+    if (searchProgress) {
+      searchProgress.innerText = _("Preparing search...");
+    }
+    Search.startPulse();
+
+    // index already loaded, the browser was quick!
+    if (Search.hasIndex()) Search.query(query);
+    else Search.deferQuery(query);
+  },
+
+  /**
+   * execute search (requires search index to be loaded)
+   */
+  query: (query) => {
+    const filenames = Search._index.filenames;
+    const docNames = Search._index.docnames;
+    const titles = Search._index.titles;
+    const allTitles = Search._index.alltitles;
+    const indexEntries = Search._index.indexentries;
+
+    // stem the search terms and add them to the correct list
+    const stemmer = new Stemmer();
+    const searchTerms = new Set();
+    const excludedTerms = new Set();
+    const highlightTerms = new Set();
+    const objectTerms = new Set(splitQuery(query.toLowerCase().trim()));
+    splitQuery(query.trim()).forEach((queryTerm) => {
+      const queryTermLower = queryTerm.toLowerCase();
+
+      // maybe skip this "word"
+      // stopwords array is from language_data.js
+      if (
+        stopwords.indexOf(queryTermLower) !== -1 ||
+        queryTerm.match(/^\d+$/)
+      )
+        return;
+
+      // stem the word
+      let word = stemmer.stemWord(queryTermLower);
+      // select the correct list
+      if (word[0] === "-") excludedTerms.add(word.substr(1));
+      else {
+        searchTerms.add(word);
+        highlightTerms.add(queryTermLower);
+      }
+    });
+
+    if (SPHINX_HIGHLIGHT_ENABLED) {  // set in sphinx_highlight.js
+      localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" "))
+    }
+
+    // console.debug("SEARCH: searching for:");
+    // console.info("required: ", [...searchTerms]);
+    // console.info("excluded: ", [...excludedTerms]);
+
+    // array of [docname, title, anchor, descr, score, filename]
+    let results = [];
+    _removeChildren(document.getElementById("search-progress"));
+
+    const queryLower = query.toLowerCase();
+    for (const [title, foundTitles] of Object.entries(allTitles)) {
+      if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) {
+        for (const [file, id] of foundTitles) {
+          let score = Math.round(100 * queryLower.length / title.length)
+          results.push([
+            docNames[file],
+            titles[file] !== title ? `${titles[file]} > ${title}` : title,
+            id !== null ? "#" + id : "",
+            null,
+            score,
+            filenames[file],
+          ]);
+        }
+      }
+    }
+
+    // search for explicit entries in index directives
+    for (const [entry, foundEntries] of Object.entries(indexEntries)) {
+      if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) {
+        for (const [file, id] of foundEntries) {
+          let score = Math.round(100 * queryLower.length / entry.length)
+          results.push([
+            docNames[file],
+            titles[file],
+            id ? "#" + id : "",
+            null,
+            score,
+            filenames[file],
+          ]);
+        }
+      }
+    }
+
+    // lookup as object
+    objectTerms.forEach((term) =>
+      results.push(...Search.performObjectSearch(term, objectTerms))
+    );
+
+    // lookup as search terms in fulltext
+    results.push(...Search.performTermsSearch(searchTerms, excludedTerms));
+
+    // let the scorer override scores with a custom scoring function
+    if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item)));
+
+    // now sort the results by score (in opposite order of appearance, since the
+    // display function below uses pop() to retrieve items) and then
+    // alphabetically
+    results.sort((a, b) => {
+      const leftScore = a[4];
+      const rightScore = b[4];
+      if (leftScore === rightScore) {
+        // same score: sort alphabetically
+        const leftTitle = a[1].toLowerCase();
+        const rightTitle = b[1].toLowerCase();
+        if (leftTitle === rightTitle) return 0;
+        return leftTitle > rightTitle ? -1 : 1; // inverted is intentional
+      }
+      return leftScore > rightScore ? 1 : -1;
+    });
+
+    // remove duplicate search results
+    // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept
+    let seen = new Set();
+    results = results.reverse().reduce((acc, result) => {
+      let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(',');
+      if (!seen.has(resultStr)) {
+        acc.push(result);
+        seen.add(resultStr);
+      }
+      return acc;
+    }, []);
+
+    results = results.reverse();
+
+    // for debugging
+    //Search.lastresults = results.slice();  // a copy
+    // console.info("search results:", Search.lastresults);
+
+    // print the results
+    _displayNextItem(results, results.length, searchTerms);
+  },
+
+  /**
+   * search for object names
+   */
+  performObjectSearch: (object, objectTerms) => {
+    const filenames = Search._index.filenames;
+    const docNames = Search._index.docnames;
+    const objects = Search._index.objects;
+    const objNames = Search._index.objnames;
+    const titles = Search._index.titles;
+
+    const results = [];
+
+    const objectSearchCallback = (prefix, match) => {
+      const name = match[4]
+      const fullname = (prefix ? prefix + "." : "") + name;
+      const fullnameLower = fullname.toLowerCase();
+      if (fullnameLower.indexOf(object) < 0) return;
+
+      let score = 0;
+      const parts = fullnameLower.split(".");
+
+      // check for different match types: exact matches of full name or
+      // "last name" (i.e. last dotted part)
+      if (fullnameLower === object || parts.slice(-1)[0] === object)
+        score += Scorer.objNameMatch;
+      else if (parts.slice(-1)[0].indexOf(object) > -1)
+        score += Scorer.objPartialMatch; // matches in last name
+
+      const objName = objNames[match[1]][2];
+      const title = titles[match[0]];
+
+      // If more than one term searched for, we require other words to be
+      // found in the name/title/description
+      const otherTerms = new Set(objectTerms);
+      otherTerms.delete(object);
+      if (otherTerms.size > 0) {
+        const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase();
+        if (
+          [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0)
+        )
+          return;
+      }
+
+      let anchor = match[3];
+      if (anchor === "") anchor = fullname;
+      else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname;
+
+      const descr = objName + _(", in ") + title;
+
+      // add custom score for some objects according to scorer
+      if (Scorer.objPrio.hasOwnProperty(match[2]))
+        score += Scorer.objPrio[match[2]];
+      else score += Scorer.objPrioDefault;
+
+      results.push([
+        docNames[match[0]],
+        fullname,
+        "#" + anchor,
+        descr,
+        score,
+        filenames[match[0]],
+      ]);
+    };
+    Object.keys(objects).forEach((prefix) =>
+      objects[prefix].forEach((array) =>
+        objectSearchCallback(prefix, array)
+      )
+    );
+    return results;
+  },
+
+  /**
+   * search for full-text terms in the index
+   */
+  performTermsSearch: (searchTerms, excludedTerms) => {
+    // prepare search
+    const terms = Search._index.terms;
+    const titleTerms = Search._index.titleterms;
+    const filenames = Search._index.filenames;
+    const docNames = Search._index.docnames;
+    const titles = Search._index.titles;
+
+    const scoreMap = new Map();
+    const fileMap = new Map();
+
+    // perform the search on the required terms
+    searchTerms.forEach((word) => {
+      const files = [];
+      const arr = [
+        { files: terms[word], score: Scorer.term },
+        { files: titleTerms[word], score: Scorer.title },
+      ];
+      // add support for partial matches
+      if (word.length > 2) {
+        const escapedWord = _escapeRegExp(word);
+        Object.keys(terms).forEach((term) => {
+          if (term.match(escapedWord) && !terms[word])
+            arr.push({ files: terms[term], score: Scorer.partialTerm });
+        });
+        Object.keys(titleTerms).forEach((term) => {
+          if (term.match(escapedWord) && !titleTerms[word])
+            arr.push({ files: titleTerms[word], score: Scorer.partialTitle });
+        });
+      }
+
+      // no match but word was a required one
+      if (arr.every((record) => record.files === undefined)) return;
+
+      // found search word in contents
+      arr.forEach((record) => {
+        if (record.files === undefined) return;
+
+        let recordFiles = record.files;
+        if (recordFiles.length === undefined) recordFiles = [recordFiles];
+        files.push(...recordFiles);
+
+        // set score for the word in each file
+        recordFiles.forEach((file) => {
+          if (!scoreMap.has(file)) scoreMap.set(file, {});
+          scoreMap.get(file)[word] = record.score;
+        });
+      });
+
+      // create the mapping
+      files.forEach((file) => {
+        if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1)
+          fileMap.get(file).push(word);
+        else fileMap.set(file, [word]);
+      });
+    });
+
+    // now check if the files don't contain excluded terms
+    const results = [];
+    for (const [file, wordList] of fileMap) {
+      // check if all requirements are matched
+
+      // as search terms with length < 3 are discarded
+      const filteredTermCount = [...searchTerms].filter(
+        (term) => term.length > 2
+      ).length;
+      if (
+        wordList.length !== searchTerms.size &&
+        wordList.length !== filteredTermCount
+      )
+        continue;
+
+      // ensure that none of the excluded terms is in the search result
+      if (
+        [...excludedTerms].some(
+          (term) =>
+            terms[term] === file ||
+            titleTerms[term] === file ||
+            (terms[term] || []).includes(file) ||
+            (titleTerms[term] || []).includes(file)
+        )
+      )
+        break;
+
+      // select one (max) score for the file.
+      const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w]));
+      // add result to the result list
+      results.push([
+        docNames[file],
+        titles[file],
+        "",
+        null,
+        score,
+        filenames[file],
+      ]);
+    }
+    return results;
+  },
+
+  /**
+   * helper function to return a node containing the
+   * search summary for a given text. keywords is a list
+   * of stemmed words.
+   */
+  makeSearchSummary: (htmlText, keywords) => {
+    const text = Search.htmlToText(htmlText);
+    if (text === "") return null;
+
+    const textLower = text.toLowerCase();
+    const actualStartPosition = [...keywords]
+      .map((k) => textLower.indexOf(k.toLowerCase()))
+      .filter((i) => i > -1)
+      .slice(-1)[0];
+    const startWithContext = Math.max(actualStartPosition - 120, 0);
+
+    const top = startWithContext === 0 ? "" : "...";
+    const tail = startWithContext + 240 < text.length ? "..." : "";
+
+    let summary = document.createElement("p");
+    summary.classList.add("context");
+    summary.textContent = top + text.substr(startWithContext, 240).trim() + tail;
+
+    return summary;
+  },
+};
+
+_ready(Search.init);

docs/build/html/_static/sphinx_highlight.js

@@ -0,0 +1,144 @@
+/* Highlighting utilities for Sphinx HTML documentation. */
+"use strict";
+
+const SPHINX_HIGHLIGHT_ENABLED = true
+
+/**
+ * highlight a given string on a node by wrapping it in
+ * span elements with the given class name.
+ */
+const _highlight = (node, addItems, text, className) => {
+  if (node.nodeType === Node.TEXT_NODE) {
+    const val = node.nodeValue;
+    const parent = node.parentNode;
+    const pos = val.toLowerCase().indexOf(text);
+    if (
+      pos >= 0 &&
+      !parent.classList.contains(className) &&
+      !parent.classList.contains("nohighlight")
+    ) {
+      let span;
+
+      const closestNode = parent.closest("body, svg, foreignObject");
+      const isInSVG = closestNode && closestNode.matches("svg");
+      if (isInSVG) {
+        span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+      } else {
+        span = document.createElement("span");
+        span.classList.add(className);
+      }
+
+      span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+      parent.insertBefore(
+        span,
+        parent.insertBefore(
+          document.createTextNode(val.substr(pos + text.length)),
+          node.nextSibling
+        )
+      );
+      node.nodeValue = val.substr(0, pos);
+
+      if (isInSVG) {
+        const rect = document.createElementNS(
+          "http://www.w3.org/2000/svg",
+          "rect"
+        );
+        const bbox = parent.getBBox();
+        rect.x.baseVal.value = bbox.x;
+        rect.y.baseVal.value = bbox.y;
+        rect.width.baseVal.value = bbox.width;
+        rect.height.baseVal.value = bbox.height;
+        rect.setAttribute("class", className);
+        addItems.push({ parent: parent, target: rect });
+      }
+    }
+  } else if (node.matches && !node.matches("button, select, textarea")) {
+    node.childNodes.forEach((el) => _highlight(el, addItems, text, className));
+  }
+};
+const _highlightText = (thisNode, text, className) => {
+  let addItems = [];
+  _highlight(thisNode, addItems, text, className);
+  addItems.forEach((obj) =>
+    obj.parent.insertAdjacentElement("beforebegin", obj.target)
+  );
+};
+
+/**
+ * Small JavaScript module for the documentation.
+ */
+const SphinxHighlight = {
+
+  /**
+   * highlight the search words provided in localstorage in the text
+   */
+  highlightSearchWords: () => {
+    if (!SPHINX_HIGHLIGHT_ENABLED) return;  // bail if no highlight
+
+    // get and clear terms from localstorage
+    const url = new URL(window.location);
+    const highlight =
+        localStorage.getItem("sphinx_highlight_terms")
+        || url.searchParams.get("highlight")
+        || "";
+    localStorage.removeItem("sphinx_highlight_terms")
+    url.searchParams.delete("highlight");
+    window.history.replaceState({}, "", url);
+
+    // get individual terms from highlight string
+    const terms = highlight.toLowerCase().split(/\s+/).filter(x => x);
+    if (terms.length === 0) return; // nothing to do
+
+    // There should never be more than one element matching "div.body"
+    const divBody = document.querySelectorAll("div.body");
+    const body = divBody.length ? divBody[0] : document.querySelector("body");
+    window.setTimeout(() => {
+      terms.forEach((term) => _highlightText(body, term, "highlighted"));
+    }, 10);
+
+    const searchBox = document.getElementById("searchbox");
+    if (searchBox === null) return;
+    searchBox.appendChild(
+      document
+        .createRange()
+        .createContextualFragment(
+          '<p class="highlight-link">' +
+            '<a href="javascript:SphinxHighlight.hideSearchWords()">' +
+            _("Hide Search Matches") +
+            "</a></p>"
+        )
+    );
+  },
+
+  /**
+   * helper function to hide the search marks again
+   */
+  hideSearchWords: () => {
+    document
+      .querySelectorAll("#searchbox .highlight-link")
+      .forEach((el) => el.remove());
+    document
+      .querySelectorAll("span.highlighted")
+      .forEach((el) => el.classList.remove("highlighted"));
+    localStorage.removeItem("sphinx_highlight_terms")
+  },
+
+  initEscapeListener: () => {
+    // only install a listener if it is really needed
+    if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return;
+
+    document.addEventListener("keydown", (event) => {
+      // bail for input elements
+      if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
+      // bail with special keys
+      if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return;
+      if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) {
+        SphinxHighlight.hideSearchWords();
+        event.preventDefault();
+      }
+    });
+  },
+};
+
+_ready(SphinxHighlight.highlightSearchWords);
+_ready(SphinxHighlight.initEscapeListener);

docs/build/html/cdaweb_utils.html

@@ -0,0 +1,135 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en">
+<head>
+  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>cdaweb_utils module &mdash; Kaipy 1.0.0 documentation</title>
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
+
+  
+  <!--[if lt IE 9]>
+    <script src="_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+  
+        <script src="_static/jquery.js"></script>
+        <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
+        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
+        <script src="_static/doctools.js"></script>
+        <script src="_static/sphinx_highlight.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" />
+    <link rel="next" title="chimp package" href="chimp.html" />
+    <link rel="prev" title="kaipy" href="modules.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">
+            Kaipy
+          </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">Contents:</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="modules.html">kaipy</a><ul class="current">
+<li class="toctree-l2 current"><a class="current reference internal" href="#">cdaweb_utils module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="chimp.html">chimp package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="embiggenUtils.html">embiggenUtils module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="gamera.html">gamera package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="gamhelio.html">gamhelio package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kJobs.html">kJobs module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaiH5.html">kaiH5 module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaiTools.html">kaiTools module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaiViz.html">kaiViz module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaijson.html">kaijson module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaixdmf.html">kaixdmf module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kdefs.html">kdefs module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="lfm2kaiju.html">lfm2kaiju module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="paraview.html">paraview package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rcm.html">rcm package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="remix.html">remix package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="solarWind.html">solarWind package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="supermag_api.html">supermag_api module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="supermage.html">supermage module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="transform.html">transform module</a></li>
+</ul>
+</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">Kaipy</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="modules.html">kaipy</a></li>
+      <li class="breadcrumb-item active">cdaweb_utils module</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="_sources/cdaweb_utils.rst.txt" rel="nofollow"> View page source</a>
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+             
+  <section id="cdaweb-utils-module">
+<h1>cdaweb_utils module<a class="headerlink" href="#cdaweb-utils-module" title="Permalink to this heading"></a></h1>
+</section>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="modules.html" class="btn btn-neutral float-left" title="kaipy" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="chimp.html" class="btn btn-neutral float-right" title="chimp package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, Center for Geospace Storms.</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>

docs/build/html/chimp.html

@@ -0,0 +1,241 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en">
+<head>
+  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>chimp package &mdash; Kaipy 1.0.0 documentation</title>
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
+
+  
+  <!--[if lt IE 9]>
+    <script src="_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+  
+        <script src="_static/jquery.js"></script>
+        <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
+        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
+        <script src="_static/doctools.js"></script>
+        <script src="_static/sphinx_highlight.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" />
+    <link rel="next" title="embiggenUtils module" href="embiggenUtils.html" />
+    <link rel="prev" title="cdaweb_utils module" href="cdaweb_utils.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">
+            Kaipy
+          </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">Contents:</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="modules.html">kaipy</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="cdaweb_utils.html">cdaweb_utils module</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">chimp package</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#module-chimp.chimph5p">chimp.chimph5p module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#chimp.chimph5p.bndTPs"><code class="docutils literal notranslate"><span class="pre">bndTPs()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#chimp.chimph5p.cntSteps"><code class="docutils literal notranslate"><span class="pre">cntSteps()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#chimp.chimph5p.cntTPs"><code class="docutils literal notranslate"><span class="pre">cntTPs()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#chimp.chimph5p.getH5p"><code class="docutils literal notranslate"><span class="pre">getH5p()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#chimp.chimph5p.getH5pT"><code class="docutils literal notranslate"><span class="pre">getH5pT()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#chimp.chimph5p.getH5pid"><code class="docutils literal notranslate"><span class="pre">getH5pid()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#chimp.chimph5p.locPID"><code class="docutils literal notranslate"><span class="pre">locPID()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#chimp.chimph5p.tStep"><code class="docutils literal notranslate"><span class="pre">tStep()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="#module-chimp.chimpviz">chimp.chimpviz module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#chimp.chimpviz.AddTPs"><code class="docutils literal notranslate"><span class="pre">AddTPs()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="#module-chimp.kCyl">chimp.kCyl module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#chimp.kCyl.PIso"><code class="docutils literal notranslate"><span class="pre">PIso()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#chimp.kCyl.getEQGrid"><code class="docutils literal notranslate"><span class="pre">getEQGrid()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#chimp.kCyl.getGrid"><code class="docutils literal notranslate"><span class="pre">getGrid()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#chimp.kCyl.getSlc"><code class="docutils literal notranslate"><span class="pre">getSlc()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="#module-chimp">Module contents</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="embiggenUtils.html">embiggenUtils module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="gamera.html">gamera package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="gamhelio.html">gamhelio package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kJobs.html">kJobs module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaiH5.html">kaiH5 module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaiTools.html">kaiTools module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaiViz.html">kaiViz module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaijson.html">kaijson module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaixdmf.html">kaixdmf module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kdefs.html">kdefs module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="lfm2kaiju.html">lfm2kaiju module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="paraview.html">paraview package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rcm.html">rcm package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="remix.html">remix package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="solarWind.html">solarWind package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="supermag_api.html">supermag_api module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="supermage.html">supermage module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="transform.html">transform module</a></li>
+</ul>
+</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">Kaipy</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="modules.html">kaipy</a></li>
+      <li class="breadcrumb-item active">chimp package</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="_sources/chimp.rst.txt" rel="nofollow"> View page source</a>
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+             
+  <section id="chimp-package">
+<h1>chimp package<a class="headerlink" href="#chimp-package" title="Permalink to this heading"></a></h1>
+<section id="submodules">
+<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
+</section>
+<section id="module-chimp.chimph5p">
+<span id="chimp-chimph5p-module"></span><h2>chimp.chimph5p module<a class="headerlink" href="#module-chimp.chimph5p" title="Permalink to this heading"></a></h2>
+<dl class="py function">
+<dt class="sig sig-object py" id="chimp.chimph5p.bndTPs">
+<span class="sig-prename descclassname"><span class="pre">chimp.chimph5p.</span></span><span class="sig-name descname"><span class="pre">bndTPs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fname</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#chimp.chimph5p.bndTPs" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="chimp.chimph5p.cntSteps">
+<span class="sig-prename descclassname"><span class="pre">chimp.chimph5p.</span></span><span class="sig-name descname"><span class="pre">cntSteps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fname</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#chimp.chimph5p.cntSteps" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="chimp.chimph5p.cntTPs">
+<span class="sig-prename descclassname"><span class="pre">chimp.chimph5p.</span></span><span class="sig-name descname"><span class="pre">cntTPs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fname</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#chimp.chimph5p.cntTPs" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="chimp.chimph5p.getH5p">
+<span class="sig-prename descclassname"><span class="pre">chimp.chimph5p.</span></span><span class="sig-name descname"><span class="pre">getH5p</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fname</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vId</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Mask</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#chimp.chimph5p.getH5p" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="chimp.chimph5p.getH5pT">
+<span class="sig-prename descclassname"><span class="pre">chimp.chimph5p.</span></span><span class="sig-name descname"><span class="pre">getH5pT</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fname</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vID</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'isIn'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nStp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cutIn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#chimp.chimph5p.getH5pT" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="chimp.chimph5p.getH5pid">
+<span class="sig-prename descclassname"><span class="pre">chimp.chimph5p.</span></span><span class="sig-name descname"><span class="pre">getH5pid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fname</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vId</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pid</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#chimp.chimph5p.getH5pid" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="chimp.chimph5p.locPID">
+<span class="sig-prename descclassname"><span class="pre">chimp.chimph5p.</span></span><span class="sig-name descname"><span class="pre">locPID</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fname</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pid</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#chimp.chimph5p.locPID" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="chimp.chimph5p.tStep">
+<span class="sig-prename descclassname"><span class="pre">chimp.chimph5p.</span></span><span class="sig-name descname"><span class="pre">tStep</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fname</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nStp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#chimp.chimph5p.tStep" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+</section>
+<section id="module-chimp.chimpviz">
+<span id="chimp-chimpviz-module"></span><h2>chimp.chimpviz module<a class="headerlink" href="#module-chimp.chimpviz" title="Permalink to this heading"></a></h2>
+<dl class="py function">
+<dt class="sig sig-object py" id="chimp.chimpviz.AddTPs">
+<span class="sig-prename descclassname"><span class="pre">chimp.chimpviz.</span></span><span class="sig-name descname"><span class="pre">AddTPs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">xyz</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">V</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vIDs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fOut</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'tps.h5'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nStp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#chimp.chimpviz.AddTPs" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+</section>
+<section id="module-chimp.kCyl">
+<span id="chimp-kcyl-module"></span><h2>chimp.kCyl module<a class="headerlink" href="#module-chimp.kCyl" title="Permalink to this heading"></a></h2>
+<dl class="py function">
+<dt class="sig sig-object py" id="chimp.kCyl.PIso">
+<span class="sig-prename descclassname"><span class="pre">chimp.kCyl.</span></span><span class="sig-name descname"><span class="pre">PIso</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fIn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nStp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pCut</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.001</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doAsym</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#chimp.kCyl.PIso" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="chimp.kCyl.getEQGrid">
+<span class="sig-prename descclassname"><span class="pre">chimp.kCyl.</span></span><span class="sig-name descname"><span class="pre">getEQGrid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fIn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doCenter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doWrap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#chimp.kCyl.getEQGrid" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="chimp.kCyl.getGrid">
+<span class="sig-prename descclassname"><span class="pre">chimp.kCyl.</span></span><span class="sig-name descname"><span class="pre">getGrid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fIn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">do4D</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#chimp.kCyl.getGrid" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="chimp.kCyl.getSlc">
+<span class="sig-prename descclassname"><span class="pre">chimp.kCyl.</span></span><span class="sig-name descname"><span class="pre">getSlc</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fIn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nStp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vID</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'jPSD'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doWrap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#chimp.kCyl.getSlc" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+</section>
+<section id="module-chimp">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-chimp" title="Permalink to this heading"></a></h2>
+</section>
+</section>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="cdaweb_utils.html" class="btn btn-neutral float-left" title="cdaweb_utils module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="embiggenUtils.html" class="btn btn-neutral float-right" title="embiggenUtils module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, Center for Geospace Storms.</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>

docs/build/html/embiggenUtils.html

@@ -0,0 +1,227 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en">
+<head>
+  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>embiggenUtils module &mdash; Kaipy 1.0.0 documentation</title>
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
+
+  
+  <!--[if lt IE 9]>
+    <script src="_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+  
+        <script src="_static/jquery.js"></script>
+        <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
+        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
+        <script src="_static/doctools.js"></script>
+        <script src="_static/sphinx_highlight.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" />
+    <link rel="next" title="gamera package" href="gamera.html" />
+    <link rel="prev" title="chimp package" href="chimp.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">
+            Kaipy
+          </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">Contents:</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="modules.html">kaipy</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="cdaweb_utils.html">cdaweb_utils module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="chimp.html">chimp package</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">embiggenUtils module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.Bvec2Global"><code class="docutils literal notranslate"><span class="pre">Bvec2Global()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.CompRestarts"><code class="docutils literal notranslate"><span class="pre">CompRestarts()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.Corner2Global"><code class="docutils literal notranslate"><span class="pre">Corner2Global()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.Flux2Global"><code class="docutils literal notranslate"><span class="pre">Flux2Global()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.Gas2Global"><code class="docutils literal notranslate"><span class="pre">Gas2Global()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.MaxDiv"><code class="docutils literal notranslate"><span class="pre">MaxDiv()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.PullRestartMPI"><code class="docutils literal notranslate"><span class="pre">PullRestartMPI()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.PushRestartMPI"><code class="docutils literal notranslate"><span class="pre">PushRestartMPI()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.Volume"><code class="docutils literal notranslate"><span class="pre">Volume()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.ccL2G"><code class="docutils literal notranslate"><span class="pre">ccL2G()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.upCCMag"><code class="docutils literal notranslate"><span class="pre">upCCMag()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.upFlux"><code class="docutils literal notranslate"><span class="pre">upFlux()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.upGas"><code class="docutils literal notranslate"><span class="pre">upGas()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.upGrid"><code class="docutils literal notranslate"><span class="pre">upGrid()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.upVarCC"><code class="docutils literal notranslate"><span class="pre">upVarCC()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="gamera.html">gamera package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="gamhelio.html">gamhelio package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kJobs.html">kJobs module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaiH5.html">kaiH5 module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaiTools.html">kaiTools module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaiViz.html">kaiViz module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaijson.html">kaijson module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaixdmf.html">kaixdmf module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kdefs.html">kdefs module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="lfm2kaiju.html">lfm2kaiju module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="paraview.html">paraview package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rcm.html">rcm package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="remix.html">remix package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="solarWind.html">solarWind package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="supermag_api.html">supermag_api module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="supermage.html">supermage module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="transform.html">transform module</a></li>
+</ul>
+</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">Kaipy</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="modules.html">kaipy</a></li>
+      <li class="breadcrumb-item active">embiggenUtils module</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="_sources/embiggenUtils.rst.txt" rel="nofollow"> View page source</a>
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+             
+  <section id="module-embiggenUtils">
+<span id="embiggenutils-module"></span><h1>embiggenUtils module<a class="headerlink" href="#module-embiggenUtils" title="Permalink to this heading"></a></h1>
+<dl class="py function">
+<dt class="sig sig-object py" id="embiggenUtils.Bvec2Global">
+<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">Bvec2Global</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">B</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">iH5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">i</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">j</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">k</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ri</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rj</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rk</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nip</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Njp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nkp</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.Bvec2Global" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="embiggenUtils.CompRestarts">
+<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">CompRestarts</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">iStr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oStr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nRes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ri</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rj</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rk</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.CompRestarts" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="embiggenUtils.Corner2Global">
+<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">Corner2Global</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Q</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">iH5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">i</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">j</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">k</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ri</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rj</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rk</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nip</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Njp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nkp</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.Corner2Global" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="embiggenUtils.Flux2Global">
+<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">Flux2Global</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">M</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">iH5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">i</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">j</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">k</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ri</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rj</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rk</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nip</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Njp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nkp</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.Flux2Global" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="embiggenUtils.Gas2Global">
+<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">Gas2Global</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">G</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">iH5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">i</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">j</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">k</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ri</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rj</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rk</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nip</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Njp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nkp</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.Gas2Global" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="embiggenUtils.MaxDiv">
+<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">MaxDiv</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">M</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.MaxDiv" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="embiggenUtils.PullRestartMPI">
+<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">PullRestartMPI</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bStr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nRes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ri</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rj</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rk</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.PullRestartMPI" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="embiggenUtils.PushRestartMPI">
+<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">PushRestartMPI</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">outid</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nRes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ri</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rj</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rk</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">X</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Z</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nG</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nM</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nB</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oG</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oM</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oB</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">G0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">f0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dtScl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.PushRestartMPI" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="embiggenUtils.Volume">
+<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">Volume</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Xg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Yg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Zg</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.Volume" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="embiggenUtils.ccL2G">
+<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">ccL2G</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">i</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ri</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nip</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.ccL2G" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="embiggenUtils.upCCMag">
+<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">upCCMag</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">B</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dV0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dVu</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vID</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Bxyz'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.upCCMag" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="embiggenUtils.upFlux">
+<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">upFlux</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">M</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.upFlux" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="embiggenUtils.upGas">
+<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">upGas</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">G</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dV0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dVu</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vID</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Gas'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.upGas" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="embiggenUtils.upGrid">
+<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">upGrid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">X</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Z</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.upGrid" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="embiggenUtils.upVarCC">
+<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">upVarCC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Q</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dV0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dVu</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.upVarCC" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+</section>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="chimp.html" class="btn btn-neutral float-left" title="chimp package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="gamera.html" class="btn btn-neutral float-right" title="gamera package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, Center for Geospace Storms.</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>

docs/build/html/gamera.html

@@ -0,0 +1,770 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en">
+<head>
+  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>gamera package &mdash; Kaipy 1.0.0 documentation</title>
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
+
+  
+  <!--[if lt IE 9]>
+    <script src="_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+  
+        <script src="_static/jquery.js"></script>
+        <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
+        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
+        <script src="_static/doctools.js"></script>
+        <script src="_static/sphinx_highlight.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" />
+    <link rel="next" title="gamhelio package" href="gamhelio.html" />
+    <link rel="prev" title="embiggenUtils module" href="embiggenUtils.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">
+            Kaipy
+          </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">Contents:</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="modules.html">kaipy</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="cdaweb_utils.html">cdaweb_utils module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="chimp.html">chimp package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="embiggenUtils.html">embiggenUtils module</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">gamera package</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#module-gamera.block_gampp">gamera.block_gampp module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.block_gampp.GameraPipe"><code class="docutils literal notranslate"><span class="pre">GameraPipe</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="#gamera-deltabviz-module">gamera.deltabViz module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#module-gamera.gamGrids">gamera.gamGrids module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.gamGrids.Aug2D"><code class="docutils literal notranslate"><span class="pre">Aug2D()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.gamGrids.Aug2Dext"><code class="docutils literal notranslate"><span class="pre">Aug2Dext()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.gamGrids.Aug3D"><code class="docutils literal notranslate"><span class="pre">Aug3D()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.gamGrids.Egglipses"><code class="docutils literal notranslate"><span class="pre">Egglipses()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.gamGrids.GenKSph"><code class="docutils literal notranslate"><span class="pre">GenKSph()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.gamGrids.GenKSphNonU"><code class="docutils literal notranslate"><span class="pre">GenKSphNonU()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.gamGrids.GenKSphNonUGL"><code class="docutils literal notranslate"><span class="pre">GenKSphNonUGL()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.gamGrids.LoadTabG"><code class="docutils literal notranslate"><span class="pre">LoadTabG()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.gamGrids.PrintRing"><code class="docutils literal notranslate"><span class="pre">PrintRing()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.gamGrids.RampUp"><code class="docutils literal notranslate"><span class="pre">RampUp()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.gamGrids.VizGrid"><code class="docutils literal notranslate"><span class="pre">VizGrid()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.gamGrids.WriteChimp"><code class="docutils literal notranslate"><span class="pre">WriteChimp()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.gamGrids.WriteGrid"><code class="docutils literal notranslate"><span class="pre">WriteGrid()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.gamGrids.genEgg"><code class="docutils literal notranslate"><span class="pre">genEgg()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.gamGrids.genEllip"><code class="docutils literal notranslate"><span class="pre">genEllip()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.gamGrids.genFatEgg"><code class="docutils literal notranslate"><span class="pre">genFatEgg()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.gamGrids.genLFM"><code class="docutils literal notranslate"><span class="pre">genLFM()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.gamGrids.genRing"><code class="docutils literal notranslate"><span class="pre">genRing()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.gamGrids.genSph"><code class="docutils literal notranslate"><span class="pre">genSph()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.gamGrids.getLFM"><code class="docutils literal notranslate"><span class="pre">getLFM()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.gamGrids.regrid"><code class="docutils literal notranslate"><span class="pre">regrid()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="#module-gamera.gampp">gamera.gampp module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.gampp.GameraPipe"><code class="docutils literal notranslate"><span class="pre">GameraPipe</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="#module-gamera.magsphere">gamera.magsphere module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.magsphere.GamsphPipe"><code class="docutils literal notranslate"><span class="pre">GamsphPipe</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="#module-gamera.magsphereRescale">gamera.magsphereRescale module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.magsphereRescale.MaxDiv"><code class="docutils literal notranslate"><span class="pre">MaxDiv()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.magsphereRescale.PullRestartMPI"><code class="docutils literal notranslate"><span class="pre">PullRestartMPI()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.magsphereRescale.PushRestartMPI"><code class="docutils literal notranslate"><span class="pre">PushRestartMPI()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.magsphereRescale.Volume"><code class="docutils literal notranslate"><span class="pre">Volume()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.magsphereRescale.downFlux"><code class="docutils literal notranslate"><span class="pre">downFlux()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.magsphereRescale.downGas"><code class="docutils literal notranslate"><span class="pre">downGas()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.magsphereRescale.downGrid"><code class="docutils literal notranslate"><span class="pre">downGrid()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.magsphereRescale.downMIX"><code class="docutils literal notranslate"><span class="pre">downMIX()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.magsphereRescale.downVolt"><code class="docutils literal notranslate"><span class="pre">downVolt()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.magsphereRescale.upFlux"><code class="docutils literal notranslate"><span class="pre">upFlux()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.magsphereRescale.upGas"><code class="docutils literal notranslate"><span class="pre">upGas()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.magsphereRescale.upGrid"><code class="docutils literal notranslate"><span class="pre">upGrid()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.magsphereRescale.upMIX"><code class="docutils literal notranslate"><span class="pre">upMIX()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.magsphereRescale.upRCM"><code class="docutils literal notranslate"><span class="pre">upRCM()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.magsphereRescale.upRCM1D"><code class="docutils literal notranslate"><span class="pre">upRCM1D()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.magsphereRescale.upRCM1Dw"><code class="docutils literal notranslate"><span class="pre">upRCM1Dw()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.magsphereRescale.upRCMCpl"><code class="docutils literal notranslate"><span class="pre">upRCMCpl()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.magsphereRescale.upVolt"><code class="docutils literal notranslate"><span class="pre">upVolt()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="#module-gamera.msphViz">gamera.msphViz module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.msphViz.AddIonBoxes"><code class="docutils literal notranslate"><span class="pre">AddIonBoxes()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.msphViz.AddSizeArgs"><code class="docutils literal notranslate"><span class="pre">AddSizeArgs()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.msphViz.CalcTotalErrAbs"><code class="docutils literal notranslate"><span class="pre">CalcTotalErrAbs()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.msphViz.CalcTotalErrRel"><code class="docutils literal notranslate"><span class="pre">CalcTotalErrRel()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.msphViz.GetSizeBds"><code class="docutils literal notranslate"><span class="pre">GetSizeBds()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.msphViz.PlotEqB"><code class="docutils literal notranslate"><span class="pre">PlotEqB()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.msphViz.PlotEqEphi"><code class="docutils literal notranslate"><span class="pre">PlotEqEphi()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.msphViz.PlotEqErrAbs"><code class="docutils literal notranslate"><span class="pre">PlotEqErrAbs()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.msphViz.PlotEqErrRel"><code class="docutils literal notranslate"><span class="pre">PlotEqErrRel()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.msphViz.PlotJyXZ"><code class="docutils literal notranslate"><span class="pre">PlotJyXZ()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.msphViz.PlotLogicalErrAbs"><code class="docutils literal notranslate"><span class="pre">PlotLogicalErrAbs()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.msphViz.PlotLogicalErrRel"><code class="docutils literal notranslate"><span class="pre">PlotLogicalErrRel()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.msphViz.PlotMPI"><code class="docutils literal notranslate"><span class="pre">PlotMPI()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.msphViz.PlotMerid"><code class="docutils literal notranslate"><span class="pre">PlotMerid()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.msphViz.plotPlane"><code class="docutils literal notranslate"><span class="pre">plotPlane()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.msphViz.plotXY"><code class="docutils literal notranslate"><span class="pre">plotXY()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.msphViz.plotXZ"><code class="docutils literal notranslate"><span class="pre">plotXZ()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="#module-gamera.rcmpp">gamera.rcmpp module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.rcmpp.AddRCMBox"><code class="docutils literal notranslate"><span class="pre">AddRCMBox()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.rcmpp.GetMask"><code class="docutils literal notranslate"><span class="pre">GetMask()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.rcmpp.GetPotential"><code class="docutils literal notranslate"><span class="pre">GetPotential()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.rcmpp.GetVarMask"><code class="docutils literal notranslate"><span class="pre">GetVarMask()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.rcmpp.RCMEq"><code class="docutils literal notranslate"><span class="pre">RCMEq()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.rcmpp.RCMInset"><code class="docutils literal notranslate"><span class="pre">RCMInset()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="#module-gamera.remixpp">gamera.remixpp module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.remixpp.AddCBs"><code class="docutils literal notranslate"><span class="pre">AddCBs()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.remixpp.AddPotCB"><code class="docutils literal notranslate"><span class="pre">AddPotCB()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#gamera.remixpp.CMIPic"><code class="docutils literal notranslate"><span class="pre">CMIPic()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="#module-gamera">Module contents</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="gamhelio.html">gamhelio package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kJobs.html">kJobs module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaiH5.html">kaiH5 module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaiTools.html">kaiTools module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaiViz.html">kaiViz module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaijson.html">kaijson module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaixdmf.html">kaixdmf module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kdefs.html">kdefs module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="lfm2kaiju.html">lfm2kaiju module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="paraview.html">paraview package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rcm.html">rcm package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="remix.html">remix package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="solarWind.html">solarWind package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="supermag_api.html">supermag_api module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="supermage.html">supermage module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="transform.html">transform module</a></li>
+</ul>
+</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">Kaipy</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="modules.html">kaipy</a></li>
+      <li class="breadcrumb-item active">gamera package</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="_sources/gamera.rst.txt" rel="nofollow"> View page source</a>
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+             
+  <section id="gamera-package">
+<h1>gamera package<a class="headerlink" href="#gamera-package" title="Permalink to this heading"></a></h1>
+<section id="submodules">
+<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
+</section>
+<section id="module-gamera.block_gampp">
+<span id="gamera-block-gampp-module"></span><h2>gamera.block_gampp module<a class="headerlink" href="#module-gamera.block_gampp" title="Permalink to this heading"></a></h2>
+<dl class="py class">
+<dt class="sig sig-object py" id="gamera.block_gampp.GameraPipe">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">gamera.block_gampp.</span></span><span class="sig-name descname"><span class="pre">GameraPipe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fdir</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ftag</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doFast</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doVerbose</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.block_gampp.GameraPipe" title="Permalink to this definition"></a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.block_gampp.GameraPipe.ChunkName">
+<span class="sig-name descname"><span class="pre">ChunkName</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">i</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">j</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">k</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.block_gampp.GameraPipe.ChunkName" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.block_gampp.GameraPipe.GetGrid">
+<span class="sig-name descname"><span class="pre">GetGrid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">doVerbose</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.block_gampp.GameraPipe.GetGrid" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.block_gampp.GameraPipe.GetRootSlice">
+<span class="sig-name descname"><span class="pre">GetRootSlice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ijkdir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'idir'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vScl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doVerb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.block_gampp.GameraPipe.GetRootSlice" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.block_gampp.GameraPipe.GetRootVar">
+<span class="sig-name descname"><span class="pre">GetRootVar</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vScl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doVerb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.block_gampp.GameraPipe.GetRootVar" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.block_gampp.GameraPipe.GetSlice">
+<span class="sig-name descname"><span class="pre">GetSlice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ijkdir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'idir'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vScl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doVerb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.block_gampp.GameraPipe.GetSlice" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.block_gampp.GameraPipe.GetVar">
+<span class="sig-name descname"><span class="pre">GetVar</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vScl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doVerb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.block_gampp.GameraPipe.GetVar" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.block_gampp.GameraPipe.OpenPipe">
+<span class="sig-name descname"><span class="pre">OpenPipe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">doVerbose</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.block_gampp.GameraPipe.OpenPipe" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.block_gampp.GameraPipe.SetUnits">
+<span class="sig-name descname"><span class="pre">SetUnits</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">f0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.block_gampp.GameraPipe.SetUnits" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</section>
+<section id="gamera-deltabviz-module">
+<h2>gamera.deltabViz module<a class="headerlink" href="#gamera-deltabviz-module" title="Permalink to this heading"></a></h2>
+</section>
+<section id="module-gamera.gamGrids">
+<span id="gamera-gamgrids-module"></span><h2>gamera.gamGrids module<a class="headerlink" href="#module-gamera.gamGrids" title="Permalink to this heading"></a></h2>
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.gamGrids.Aug2D">
+<span class="sig-prename descclassname"><span class="pre">gamera.gamGrids.</span></span><span class="sig-name descname"><span class="pre">Aug2D</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">XX</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">YY</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doEps</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">TINY</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1e-08</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">KeepOut</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rpx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.15</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gamGrids.Aug2D" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.gamGrids.Aug2Dext">
+<span class="sig-prename descclassname"><span class="pre">gamera.gamGrids.</span></span><span class="sig-name descname"><span class="pre">Aug2Dext</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">XX</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">YY</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nadd</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gamGrids.Aug2Dext" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.gamGrids.Aug3D">
+<span class="sig-prename descclassname"><span class="pre">gamera.gamGrids.</span></span><span class="sig-name descname"><span class="pre">Aug3D</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">xxG</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">yyG</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nk</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">32</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">TINY</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1e-08</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gamGrids.Aug3D" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.gamGrids.Egglipses">
+<span class="sig-prename descclassname"><span class="pre">gamera.gamGrids.</span></span><span class="sig-name descname"><span class="pre">Egglipses</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Ni</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">32</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nj</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">64</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">3.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">30.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rtail</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">250.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">NumSph</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gamGrids.Egglipses" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.gamGrids.GenKSph">
+<span class="sig-prename descclassname"><span class="pre">gamera.gamGrids.</span></span><span class="sig-name descname"><span class="pre">GenKSph</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Ni</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">32</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nj</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">64</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nk</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">32</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">40</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tMin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tMax</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.8</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gamGrids.GenKSph" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.gamGrids.GenKSphNonU">
+<span class="sig-prename descclassname"><span class="pre">gamera.gamGrids.</span></span><span class="sig-name descname"><span class="pre">GenKSphNonU</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Ni</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">32</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nj</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">64</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nk</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">32</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">40</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tMin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tMax</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.8</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gamGrids.GenKSphNonU" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.gamGrids.GenKSphNonUGL">
+<span class="sig-prename descclassname"><span class="pre">gamera.gamGrids.</span></span><span class="sig-name descname"><span class="pre">GenKSphNonUGL</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Ni</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">32</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nj</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">64</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nk</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">32</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">40</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tMin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tMax</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.8</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gamGrids.GenKSphNonUGL" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.gamGrids.LoadTabG">
+<span class="sig-prename descclassname"><span class="pre">gamera.gamGrids.</span></span><span class="sig-name descname"><span class="pre">LoadTabG</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fIn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'lfmG'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gamGrids.LoadTabG" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.gamGrids.PrintRing">
+<span class="sig-prename descclassname"><span class="pre">gamera.gamGrids.</span></span><span class="sig-name descname"><span class="pre">PrintRing</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">NCh</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rID</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'safe'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doWarn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gamGrids.PrintRing" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.gamGrids.RampUp">
+<span class="sig-prename descclassname"><span class="pre">gamera.gamGrids.</span></span><span class="sig-name descname"><span class="pre">RampUp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">r</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rC</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lC</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gamGrids.RampUp" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.gamGrids.VizGrid">
+<span class="sig-prename descclassname"><span class="pre">gamera.gamGrids.</span></span><span class="sig-name descname"><span class="pre">VizGrid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">XX</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">YY</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xxG</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">yyG</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doGhost</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doShow</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xyBds</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fOut</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'grid.png'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gamGrids.VizGrid" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.gamGrids.WriteChimp">
+<span class="sig-prename descclassname"><span class="pre">gamera.gamGrids.</span></span><span class="sig-name descname"><span class="pre">WriteChimp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">X3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Y3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Z3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fOut</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'cGrid.h5'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gamGrids.WriteChimp" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.gamGrids.WriteGrid">
+<span class="sig-prename descclassname"><span class="pre">gamera.gamGrids.</span></span><span class="sig-name descname"><span class="pre">WriteGrid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">X3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Y3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Z3</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fOut</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'gGrid.h5'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gamGrids.WriteGrid" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.gamGrids.genEgg">
+<span class="sig-prename descclassname"><span class="pre">gamera.gamGrids.</span></span><span class="sig-name descname"><span class="pre">genEgg</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Ni</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">32</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nj</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">64</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">3.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">30.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xtail</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">250</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">NumSph</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">TINY</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1e-08</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">A</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gamGrids.genEgg" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.gamGrids.genEllip">
+<span class="sig-prename descclassname"><span class="pre">gamera.gamGrids.</span></span><span class="sig-name descname"><span class="pre">genEllip</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Ni</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">32</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nj</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">64</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">3.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">30</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">TINY</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1e-08</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gamGrids.genEllip" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.gamGrids.genFatEgg">
+<span class="sig-prename descclassname"><span class="pre">gamera.gamGrids.</span></span><span class="sig-name descname"><span class="pre">genFatEgg</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Ni</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">32</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nj</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">64</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">3.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">30.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xtail</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">250</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">NumSph</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">TINY</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1e-08</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">A</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gamGrids.genFatEgg" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.gamGrids.genLFM">
+<span class="sig-prename descclassname"><span class="pre">gamera.gamGrids.</span></span><span class="sig-name descname"><span class="pre">genLFM</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Ni</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">32</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nj</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">64</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">3.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">25.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fIn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'lfm.hdf'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">TINY</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1e-08</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gamGrids.genLFM" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.gamGrids.genRing">
+<span class="sig-prename descclassname"><span class="pre">gamera.gamGrids.</span></span><span class="sig-name descname"><span class="pre">genRing</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">XX</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">YY</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nk</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">64</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Tol</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doVerb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gamGrids.genRing" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.gamGrids.genSph">
+<span class="sig-prename descclassname"><span class="pre">gamera.gamGrids.</span></span><span class="sig-name descname"><span class="pre">genSph</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Ni</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">32</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nj</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">64</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">3.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">30</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">TINY</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1e-08</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gamGrids.genSph" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.gamGrids.getLFM">
+<span class="sig-prename descclassname"><span class="pre">gamera.gamGrids.</span></span><span class="sig-name descname"><span class="pre">getLFM</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fIn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">3.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">25.0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gamGrids.getLFM" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.gamGrids.regrid">
+<span class="sig-prename descclassname"><span class="pre">gamera.gamGrids.</span></span><span class="sig-name descname"><span class="pre">regrid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">xxi</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">yyi</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ni</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nj</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">TINY</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1e-08</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gamGrids.regrid" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+</section>
+<section id="module-gamera.gampp">
+<span id="gamera-gampp-module"></span><h2>gamera.gampp module<a class="headerlink" href="#module-gamera.gampp" title="Permalink to this heading"></a></h2>
+<dl class="py class">
+<dt class="sig sig-object py" id="gamera.gampp.GameraPipe">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">gamera.gampp.</span></span><span class="sig-name descname"><span class="pre">GameraPipe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fdir</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ftag</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doFast</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doVerbose</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doParallel</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nWorkers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gampp.GameraPipe" title="Permalink to this definition"></a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.gampp.GameraPipe.GetGrid">
+<span class="sig-name descname"><span class="pre">GetGrid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">doVerbose</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gampp.GameraPipe.GetGrid" title="Permalink to this definition"></a></dt>
+<dd><p>Load Grid from Gamera HDF5 file</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.gampp.GameraPipe.GetGridParallel">
+<span class="sig-name descname"><span class="pre">GetGridParallel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">doVerbose</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gampp.GameraPipe.GetGridParallel" title="Permalink to this definition"></a></dt>
+<dd><p>Parallel read of grid datasets</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.gampp.GameraPipe.GetRootSlice">
+<span class="sig-name descname"><span class="pre">GetRootSlice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ijkdir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'idir'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vScl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doVerb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gampp.GameraPipe.GetRootSlice" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.gampp.GameraPipe.GetRootVar">
+<span class="sig-name descname"><span class="pre">GetRootVar</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vScl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doVerb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gampp.GameraPipe.GetRootVar" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.gampp.GameraPipe.GetSlice">
+<span class="sig-name descname"><span class="pre">GetSlice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ijkdir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'idir'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vScl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doVerb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gampp.GameraPipe.GetSlice" title="Permalink to this definition"></a></dt>
+<dd><p>Get variable slice of constant i,j,k
+Directions = idir/jdir/kdir strings
+Indexing = (1,Nijk)</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.gampp.GameraPipe.GetVar">
+<span class="sig-name descname"><span class="pre">GetVar</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sID</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vScl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doVerb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gampp.GameraPipe.GetVar" title="Permalink to this definition"></a></dt>
+<dd><p>Read Var with name vID</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.gampp.GameraPipe.GetVarParallel">
+<span class="sig-name descname"><span class="pre">GetVarParallel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sID</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vScl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doVerb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gampp.GameraPipe.GetVarParallel" title="Permalink to this definition"></a></dt>
+<dd><p>Parallel read of Var</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.gampp.GameraPipe.OpenPipe">
+<span class="sig-name descname"><span class="pre">OpenPipe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">doVerbose</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gampp.GameraPipe.OpenPipe" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.gampp.GameraPipe.SetUnits">
+<span class="sig-name descname"><span class="pre">SetUnits</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">f0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.gampp.GameraPipe.SetUnits" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</section>
+<section id="module-gamera.magsphere">
+<span id="gamera-magsphere-module"></span><h2>gamera.magsphere module<a class="headerlink" href="#module-gamera.magsphere" title="Permalink to this heading"></a></h2>
+<dl class="py class">
+<dt class="sig sig-object py" id="gamera.magsphere.GamsphPipe">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">gamera.magsphere.</span></span><span class="sig-name descname"><span class="pre">GamsphPipe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fdir</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ftag</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doFast</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uID</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Earth'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphere.GamsphPipe" title="Permalink to this definition"></a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">GameraPipe</span></code></p>
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.magsphere.GamsphPipe.AddCPCP">
+<span class="sig-name descname"><span class="pre">AddCPCP</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ax</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[0.9,</span> <span class="pre">0.95]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cLab</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'black'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'medium'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doBox</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">BoxC</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'lightgrey'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphere.GamsphPipe.AddCPCP" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.magsphere.GamsphPipe.AddSW">
+<span class="sig-name descname"><span class="pre">AddSW</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ax</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[0.725,</span> <span class="pre">0.025]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cLab</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'black'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'medium'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">T0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doBox</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">BoxC</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'lightgrey'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doAll</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphere.GamsphPipe.AddSW" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.magsphere.GamsphPipe.AddTime">
+<span class="sig-name descname"><span class="pre">AddTime</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ax</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[0.9,</span> <span class="pre">0.95]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cLab</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'black'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'medium'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">T0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doBox</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">BoxC</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'lightgrey'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphere.GamsphPipe.AddTime" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.magsphere.GamsphPipe.CMIViz">
+<span class="sig-name descname"><span class="pre">CMIViz</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">AxM</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nStp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doNorth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">loc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'upper</span> <span class="pre">left'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dxy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[20,</span> <span class="pre">20]</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphere.GamsphPipe.CMIViz" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.magsphere.GamsphPipe.DelBz">
+<span class="sig-name descname"><span class="pre">DelBz</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphere.GamsphPipe.DelBz" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.magsphere.GamsphPipe.EggSlice">
+<span class="sig-name descname"><span class="pre">EggSlice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sID</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vScl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doEq</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doVerb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">numGhost</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphere.GamsphPipe.EggSlice" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.magsphere.GamsphPipe.Gam2Remix">
+<span class="sig-name descname"><span class="pre">Gam2Remix</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphere.GamsphPipe.Gam2Remix" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.magsphere.GamsphPipe.GetCPCP">
+<span class="sig-name descname"><span class="pre">GetCPCP</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphere.GamsphPipe.GetCPCP" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.magsphere.GamsphPipe.GetM0">
+<span class="sig-name descname"><span class="pre">GetM0</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphere.GamsphPipe.GetM0" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.magsphere.GamsphPipe.OpenPipe">
+<span class="sig-name descname"><span class="pre">OpenPipe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">doVerbose</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphere.GamsphPipe.OpenPipe" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.magsphere.GamsphPipe.bStream">
+<span class="sig-name descname"><span class="pre">bStream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xyBds</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[-35,</span> <span class="pre">25,</span> <span class="pre">-25,</span> <span class="pre">25]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.05</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphere.GamsphPipe.bStream" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.magsphere.GamsphPipe.doStream">
+<span class="sig-name descname"><span class="pre">doStream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">U</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">V</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xyBds</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[-35,</span> <span class="pre">25,</span> <span class="pre">-25,</span> <span class="pre">25]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.05</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphere.GamsphPipe.doStream" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.magsphere.GamsphPipe.eqMagB">
+<span class="sig-name descname"><span class="pre">eqMagB</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphere.GamsphPipe.eqMagB" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamera.magsphere.GamsphPipe.vStream">
+<span class="sig-name descname"><span class="pre">vStream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xyBds</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[-35,</span> <span class="pre">25,</span> <span class="pre">-25,</span> <span class="pre">25]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.05</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphere.GamsphPipe.vStream" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</section>
+<section id="module-gamera.magsphereRescale">
+<span id="gamera-magsphererescale-module"></span><h2>gamera.magsphereRescale module<a class="headerlink" href="#module-gamera.magsphereRescale" title="Permalink to this heading"></a></h2>
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.magsphereRescale.MaxDiv">
+<span class="sig-prename descclassname"><span class="pre">gamera.magsphereRescale.</span></span><span class="sig-name descname"><span class="pre">MaxDiv</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">M</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphereRescale.MaxDiv" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.magsphereRescale.PullRestartMPI">
+<span class="sig-prename descclassname"><span class="pre">gamera.magsphereRescale.</span></span><span class="sig-name descname"><span class="pre">PullRestartMPI</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bStr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nRes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ri</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rj</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rk</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dIn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oH5</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphereRescale.PullRestartMPI" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.magsphereRescale.PushRestartMPI">
+<span class="sig-prename descclassname"><span class="pre">gamera.magsphereRescale.</span></span><span class="sig-name descname"><span class="pre">PushRestartMPI</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">outid</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nRes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ri</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rj</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rk</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">X</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Z</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">G</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">M</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oG</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oM</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fInA</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">G0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphereRescale.PushRestartMPI" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.magsphereRescale.Volume">
+<span class="sig-prename descclassname"><span class="pre">gamera.magsphereRescale.</span></span><span class="sig-name descname"><span class="pre">Volume</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Xg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Yg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Zg</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphereRescale.Volume" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.magsphereRescale.downFlux">
+<span class="sig-prename descclassname"><span class="pre">gamera.magsphereRescale.</span></span><span class="sig-name descname"><span class="pre">downFlux</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">X</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Z</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">M</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Xu</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Yu</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Zu</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphereRescale.downFlux" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.magsphereRescale.downGas">
+<span class="sig-prename descclassname"><span class="pre">gamera.magsphereRescale.</span></span><span class="sig-name descname"><span class="pre">downGas</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">X</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Z</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">G</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Xd</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Yd</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Zd</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphereRescale.downGas" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.magsphereRescale.downGrid">
+<span class="sig-prename descclassname"><span class="pre">gamera.magsphereRescale.</span></span><span class="sig-name descname"><span class="pre">downGrid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">X</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Z</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphereRescale.downGrid" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.magsphereRescale.downMIX">
+<span class="sig-prename descclassname"><span class="pre">gamera.magsphereRescale.</span></span><span class="sig-name descname"><span class="pre">downMIX</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Q</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphereRescale.downMIX" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.magsphereRescale.downVolt">
+<span class="sig-prename descclassname"><span class="pre">gamera.magsphereRescale.</span></span><span class="sig-name descname"><span class="pre">downVolt</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">G</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphereRescale.downVolt" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.magsphereRescale.upFlux">
+<span class="sig-prename descclassname"><span class="pre">gamera.magsphereRescale.</span></span><span class="sig-name descname"><span class="pre">upFlux</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">X</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Z</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">M</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Xu</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Yu</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Zu</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphereRescale.upFlux" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.magsphereRescale.upGas">
+<span class="sig-prename descclassname"><span class="pre">gamera.magsphereRescale.</span></span><span class="sig-name descname"><span class="pre">upGas</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">X</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Z</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">G</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Xu</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Yu</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Zu</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphereRescale.upGas" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.magsphereRescale.upGrid">
+<span class="sig-prename descclassname"><span class="pre">gamera.magsphereRescale.</span></span><span class="sig-name descname"><span class="pre">upGrid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">X</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Z</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphereRescale.upGrid" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.magsphereRescale.upMIX">
+<span class="sig-prename descclassname"><span class="pre">gamera.magsphereRescale.</span></span><span class="sig-name descname"><span class="pre">upMIX</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Q</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphereRescale.upMIX" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.magsphereRescale.upRCM">
+<span class="sig-prename descclassname"><span class="pre">gamera.magsphereRescale.</span></span><span class="sig-name descname"><span class="pre">upRCM</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Q</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ni</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nj</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nk</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphereRescale.upRCM" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.magsphereRescale.upRCM1D">
+<span class="sig-prename descclassname"><span class="pre">gamera.magsphereRescale.</span></span><span class="sig-name descname"><span class="pre">upRCM1D</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Q</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphereRescale.upRCM1D" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.magsphereRescale.upRCM1Dw">
+<span class="sig-prename descclassname"><span class="pre">gamera.magsphereRescale.</span></span><span class="sig-name descname"><span class="pre">upRCM1Dw</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Q</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphereRescale.upRCM1Dw" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.magsphereRescale.upRCMCpl">
+<span class="sig-prename descclassname"><span class="pre">gamera.magsphereRescale.</span></span><span class="sig-name descname"><span class="pre">upRCMCpl</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Q</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">N</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphereRescale.upRCMCpl" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.magsphereRescale.upVolt">
+<span class="sig-prename descclassname"><span class="pre">gamera.magsphereRescale.</span></span><span class="sig-name descname"><span class="pre">upVolt</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">G</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.magsphereRescale.upVolt" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+</section>
+<section id="module-gamera.msphViz">
+<span id="gamera-msphviz-module"></span><h2>gamera.msphViz module<a class="headerlink" href="#module-gamera.msphViz" title="Permalink to this heading"></a></h2>
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.msphViz.AddIonBoxes">
+<span class="sig-prename descclassname"><span class="pre">gamera.msphViz.</span></span><span class="sig-name descname"><span class="pre">AddIonBoxes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ion</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.msphViz.AddIonBoxes" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.msphViz.AddSizeArgs">
+<span class="sig-prename descclassname"><span class="pre">gamera.msphViz.</span></span><span class="sig-name descname"><span class="pre">AddSizeArgs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parser</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.msphViz.AddSizeArgs" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.msphViz.CalcTotalErrAbs">
+<span class="sig-prename descclassname"><span class="pre">gamera.msphViz.</span></span><span class="sig-name descname"><span class="pre">CalcTotalErrAbs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gsphP</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gsphO</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nStp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fieldNames</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doVerb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">meanAxis</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.msphViz.CalcTotalErrAbs" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.msphViz.CalcTotalErrRel">
+<span class="sig-prename descclassname"><span class="pre">gamera.msphViz.</span></span><span class="sig-name descname"><span class="pre">CalcTotalErrRel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gsphP</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gsphO</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nStp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fieldNames</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doVerb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">meanAxis</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.msphViz.CalcTotalErrRel" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.msphViz.GetSizeBds">
+<span class="sig-prename descclassname"><span class="pre">gamera.msphViz.</span></span><span class="sig-name descname"><span class="pre">GetSizeBds</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.msphViz.GetSizeBds" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.msphViz.PlotEqB">
+<span class="sig-prename descclassname"><span class="pre">gamera.msphViz.</span></span><span class="sig-name descname"><span class="pre">PlotEqB</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gsph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nStp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xyBds</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ax</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">AxCB</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doClear</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doDeco</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doBz</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.msphViz.PlotEqB" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.msphViz.PlotEqEphi">
+<span class="sig-prename descclassname"><span class="pre">gamera.msphViz.</span></span><span class="sig-name descname"><span class="pre">PlotEqEphi</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gsph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nStp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xyBds</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ax</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">AxCB</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doClear</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doDeco</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.msphViz.PlotEqEphi" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.msphViz.PlotEqErrAbs">
+<span class="sig-prename descclassname"><span class="pre">gamera.msphViz.</span></span><span class="sig-name descname"><span class="pre">PlotEqErrAbs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gsphP</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gsphO</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nStp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xyBds</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ax</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fieldNames</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">AxCB</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doClear</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doDeco</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vMin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1e-09</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vMax</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0001</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doLog</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doVerb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.msphViz.PlotEqErrAbs" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.msphViz.PlotEqErrRel">
+<span class="sig-prename descclassname"><span class="pre">gamera.msphViz.</span></span><span class="sig-name descname"><span class="pre">PlotEqErrRel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gsphP</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gsphO</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nStp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xyBds</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ax</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fieldNames</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">AxCB</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doClear</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doDeco</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vMin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1e-16</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vMax</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doLog</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doVerb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.msphViz.PlotEqErrRel" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.msphViz.PlotJyXZ">
+<span class="sig-prename descclassname"><span class="pre">gamera.msphViz.</span></span><span class="sig-name descname"><span class="pre">PlotJyXZ</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gsph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nStp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xyBds</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ax</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">AxCB</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">jScl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doDeco</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.msphViz.PlotJyXZ" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.msphViz.PlotLogicalErrAbs">
+<span class="sig-prename descclassname"><span class="pre">gamera.msphViz.</span></span><span class="sig-name descname"><span class="pre">PlotLogicalErrAbs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gsphP</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gsphO</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nStp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ax</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fieldNames</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">meanAxis</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">AxCB</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doClear</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doDeco</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vMin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1e-16</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vMax</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doLog</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doVerb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.msphViz.PlotLogicalErrAbs" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.msphViz.PlotLogicalErrRel">
+<span class="sig-prename descclassname"><span class="pre">gamera.msphViz.</span></span><span class="sig-name descname"><span class="pre">PlotLogicalErrRel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gsphP</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gsphO</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nStp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ax</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fieldNames</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">meanAxis</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">AxCB</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doClear</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doDeco</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vMin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1e-16</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vMax</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doLog</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doVerb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.msphViz.PlotLogicalErrRel" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.msphViz.PlotMPI">
+<span class="sig-prename descclassname"><span class="pre">gamera.msphViz.</span></span><span class="sig-name descname"><span class="pre">PlotMPI</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gsph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ax</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ashd</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.5</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.msphViz.PlotMPI" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.msphViz.PlotMerid">
+<span class="sig-prename descclassname"><span class="pre">gamera.msphViz.</span></span><span class="sig-name descname"><span class="pre">PlotMerid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gsph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nStp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xyBds</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ax</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doDen</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doRCM</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">AxCB</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doClear</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doDeco</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doSrc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.msphViz.PlotMerid" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.msphViz.plotPlane">
+<span class="sig-prename descclassname"><span class="pre">gamera.msphViz.</span></span><span class="sig-name descname"><span class="pre">plotPlane</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gsph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xyBds</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ax</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">AxCB</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">var</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'D'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vMin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vMax</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doDeco</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cmap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'viridis'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doLog</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">midp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.msphViz.plotPlane" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.msphViz.plotXY">
+<span class="sig-prename descclassname"><span class="pre">gamera.msphViz.</span></span><span class="sig-name descname"><span class="pre">plotXY</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gsph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nStp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xyBds</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ax</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">AxCB</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">var</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'D'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vMin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vMax</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doDeco</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cmap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'viridis'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doLog</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">midp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.msphViz.plotXY" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.msphViz.plotXZ">
+<span class="sig-prename descclassname"><span class="pre">gamera.msphViz.</span></span><span class="sig-name descname"><span class="pre">plotXZ</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gsph</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nStp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xzBds</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ax</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">AxCB</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">var</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'D'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vMin</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vMax</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doDeco</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cmap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'viridis'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doLog</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">midp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.msphViz.plotXZ" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+</section>
+<section id="module-gamera.rcmpp">
+<span id="gamera-rcmpp-module"></span><h2>gamera.rcmpp module<a class="headerlink" href="#module-gamera.rcmpp" title="Permalink to this heading"></a></h2>
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.rcmpp.AddRCMBox">
+<span class="sig-prename descclassname"><span class="pre">gamera.rcmpp.</span></span><span class="sig-name descname"><span class="pre">AddRCMBox</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Ax</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.rcmpp.AddRCMBox" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.rcmpp.GetMask">
+<span class="sig-prename descclassname"><span class="pre">gamera.rcmpp.</span></span><span class="sig-name descname"><span class="pre">GetMask</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rcmdata</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nStp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doVerb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.rcmpp.GetMask" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.rcmpp.GetPotential">
+<span class="sig-prename descclassname"><span class="pre">gamera.rcmpp.</span></span><span class="sig-name descname"><span class="pre">GetPotential</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rcmdata</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nStp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">I</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">NumCP</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">25</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doVerb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.rcmpp.GetPotential" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.rcmpp.GetVarMask">
+<span class="sig-prename descclassname"><span class="pre">gamera.rcmpp.</span></span><span class="sig-name descname"><span class="pre">GetVarMask</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rcmdata</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nStp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Qid</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'P'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">I</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doVerb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.rcmpp.GetVarMask" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.rcmpp.RCMEq">
+<span class="sig-prename descclassname"><span class="pre">gamera.rcmpp.</span></span><span class="sig-name descname"><span class="pre">RCMEq</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rcmdata</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nStp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doMask</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doXYZ</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doVerb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.rcmpp.RCMEq" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.rcmpp.RCMInset">
+<span class="sig-prename descclassname"><span class="pre">gamera.rcmpp.</span></span><span class="sig-name descname"><span class="pre">RCMInset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">AxRCM</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rcmdata</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nStp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vP</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pCol</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'k'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doPP</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.rcmpp.RCMInset" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+</section>
+<section id="module-gamera.remixpp">
+<span id="gamera-remixpp-module"></span><h2>gamera.remixpp module<a class="headerlink" href="#module-gamera.remixpp" title="Permalink to this heading"></a></h2>
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.remixpp.AddCBs">
+<span class="sig-prename descclassname"><span class="pre">gamera.remixpp.</span></span><span class="sig-name descname"><span class="pre">AddCBs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Ax1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ax2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Lab1</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Potential</span> <span class="pre">[kV]'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Lab2</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'FAC'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ntk1</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">7</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ntk2</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doFlip</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.remixpp.AddCBs" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.remixpp.AddPotCB">
+<span class="sig-prename descclassname"><span class="pre">gamera.remixpp.</span></span><span class="sig-name descname"><span class="pre">AddPotCB</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Ax</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Lab</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Potential</span> <span class="pre">[kV]'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ntk</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">7</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.remixpp.AddPotCB" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamera.remixpp.CMIPic">
+<span class="sig-prename descclassname"><span class="pre">gamera.remixpp.</span></span><span class="sig-name descname"><span class="pre">CMIPic</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nLat</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nLon</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">llBC</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">P</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">C</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">AxM</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doNorth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">loc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'upper</span> <span class="pre">left'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dxy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[20,</span> <span class="pre">20]</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamera.remixpp.CMIPic" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+</section>
+<section id="module-gamera">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-gamera" title="Permalink to this heading"></a></h2>
+</section>
+</section>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="embiggenUtils.html" class="btn btn-neutral float-left" title="embiggenUtils module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="gamhelio.html" class="btn btn-neutral float-right" title="gamhelio package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, Center for Geospace Storms.</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>

docs/build/html/gamhelio.html

@@ -0,0 +1,451 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en">
+<head>
+  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>gamhelio package &mdash; Kaipy 1.0.0 documentation</title>
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
+
+  
+  <!--[if lt IE 9]>
+    <script src="_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+  
+        <script src="_static/jquery.js"></script>
+        <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
+        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
+        <script src="_static/doctools.js"></script>
+        <script src="_static/sphinx_highlight.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" />
+    <link rel="next" title="gamhelio.lib package" href="gamhelio.lib.html" />
+    <link rel="prev" title="gamera package" href="gamera.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">
+            Kaipy
+          </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">Contents:</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="modules.html">kaipy</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="cdaweb_utils.html">cdaweb_utils module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="chimp.html">chimp package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="embiggenUtils.html">embiggenUtils module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="gamera.html">gamera package</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">gamhelio package</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#subpackages">Subpackages</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="gamhelio.lib.html">gamhelio.lib package</a></li>
+<li class="toctree-l4"><a class="reference internal" href="gamhelio.wsa2TDgamera.html">gamhelio.wsa2TDgamera package</a></li>
+<li class="toctree-l4"><a class="reference internal" href="gamhelio.wsa2gamera.html">gamhelio.wsa2gamera package</a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#gamhelio-helioviz-module">gamhelio.helioViz module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#module-gamhelio.heliosphere">gamhelio.heliosphere module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#gamhelio.heliosphere.GamsphPipe"><code class="docutils literal notranslate"><span class="pre">GamsphPipe</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="#module-gamhelio">Module contents</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="kJobs.html">kJobs module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaiH5.html">kaiH5 module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaiTools.html">kaiTools module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaiViz.html">kaiViz module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaijson.html">kaijson module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaixdmf.html">kaixdmf module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kdefs.html">kdefs module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="lfm2kaiju.html">lfm2kaiju module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="paraview.html">paraview package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rcm.html">rcm package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="remix.html">remix package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="solarWind.html">solarWind package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="supermag_api.html">supermag_api module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="supermage.html">supermage module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="transform.html">transform module</a></li>
+</ul>
+</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">Kaipy</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="modules.html">kaipy</a></li>
+      <li class="breadcrumb-item active">gamhelio package</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="_sources/gamhelio.rst.txt" rel="nofollow"> View page source</a>
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+             
+  <section id="gamhelio-package">
+<h1>gamhelio package<a class="headerlink" href="#gamhelio-package" title="Permalink to this heading"></a></h1>
+<section id="subpackages">
+<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this heading"></a></h2>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="gamhelio.lib.html">gamhelio.lib package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="gamhelio.lib.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="gamhelio.lib.html#module-gamhelio.lib.ace">gamhelio.lib.ace module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="gamhelio.lib.html#gamhelio.lib.ace.cdaweb_mfi"><code class="docutils literal notranslate"><span class="pre">cdaweb_mfi()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="gamhelio.lib.html#gamhelio.lib.ace.cdaweb_swe"><code class="docutils literal notranslate"><span class="pre">cdaweb_swe()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="gamhelio.lib.html#module-gamhelio.lib.cspice">gamhelio.lib.cspice module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="gamhelio.lib.html#gamhelio.lib.cspice.cspice"><code class="docutils literal notranslate"><span class="pre">cspice()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="gamhelio.lib.html#gamhelio-lib-lfmhlib-module">gamhelio.lib.lfmhlib module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="gamhelio.lib.html#gamhelio-lib-mas-module">gamhelio.lib.mas module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="gamhelio.lib.html#module-gamhelio.lib.msgr">gamhelio.lib.msgr module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="gamhelio.lib.html#gamhelio.lib.msgr.msgr"><code class="docutils literal notranslate"><span class="pre">msgr()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="gamhelio.lib.html#gamhelio.lib.msgr.msgr_v1"><code class="docutils literal notranslate"><span class="pre">msgr_v1()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="gamhelio.lib.html#module-gamhelio.lib.poisson">gamhelio.lib.poisson module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="gamhelio.lib.html#gamhelio.lib.poisson.poisson"><code class="docutils literal notranslate"><span class="pre">poisson</span></code></a><ul>
+<li class="toctree-l4"><a class="reference internal" href="gamhelio.lib.html#gamhelio.lib.poisson.poisson.residual"><code class="docutils literal notranslate"><span class="pre">poisson.residual()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="gamhelio.lib.html#gamhelio.lib.poisson.poisson.residual_xsin2"><code class="docutils literal notranslate"><span class="pre">poisson.residual_xsin2()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="gamhelio.lib.html#gamhelio.lib.poisson.poisson.setRHS"><code class="docutils literal notranslate"><span class="pre">poisson.setRHS()</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="gamhelio.lib.html#module-gamhelio.lib.util">gamhelio.lib.util module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="gamhelio.lib.html#gamhelio.lib.util.radial_interp"><code class="docutils literal notranslate"><span class="pre">radial_interp()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="gamhelio.lib.html#gamhelio.lib.util.sph2cart"><code class="docutils literal notranslate"><span class="pre">sph2cart()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="gamhelio.lib.html#module-gamhelio.lib.wsa">gamhelio.lib.wsa module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="gamhelio.lib.html#gamhelio.lib.wsa.info"><code class="docutils literal notranslate"><span class="pre">info()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="gamhelio.lib.html#gamhelio.lib.wsa.plot"><code class="docutils literal notranslate"><span class="pre">plot()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="gamhelio.lib.html#gamhelio.lib.wsa.read"><code class="docutils literal notranslate"><span class="pre">read()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="gamhelio.lib.html#module-gamhelio.lib.wsa2h5">gamhelio.lib.wsa2h5 module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="gamhelio.lib.html#module-gamhelio.lib">Module contents</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="gamhelio.wsa2TDgamera.html">gamhelio.wsa2TDgamera package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="gamhelio.wsa2TDgamera.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="gamhelio.wsa2TDgamera.html#module-gamhelio.wsa2TDgamera.params">gamhelio.wsa2TDgamera.params module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="gamhelio.wsa2TDgamera.html#gamhelio.wsa2TDgamera.params.params"><code class="docutils literal notranslate"><span class="pre">params</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="gamhelio.wsa2TDgamera.html#module-gamhelio.wsa2TDgamera">Module contents</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="gamhelio.wsa2gamera.html">gamhelio.wsa2gamera package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="gamhelio.wsa2gamera.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="gamhelio.wsa2gamera.html#module-gamhelio.wsa2gamera.params">gamhelio.wsa2gamera.params module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="gamhelio.wsa2gamera.html#gamhelio.wsa2gamera.params.params"><code class="docutils literal notranslate"><span class="pre">params</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="gamhelio.wsa2gamera.html#module-gamhelio.wsa2gamera">Module contents</a></li>
+</ul>
+</li>
+</ul>
+</div>
+</section>
+<section id="submodules">
+<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
+</section>
+<section id="gamhelio-helioviz-module">
+<h2>gamhelio.helioViz module<a class="headerlink" href="#gamhelio-helioviz-module" title="Permalink to this heading"></a></h2>
+</section>
+<section id="module-gamhelio.heliosphere">
+<span id="gamhelio-heliosphere-module"></span><h2>gamhelio.heliosphere module<a class="headerlink" href="#module-gamhelio.heliosphere" title="Permalink to this heading"></a></h2>
+<dl class="py class">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">gamhelio.heliosphere.</span></span><span class="sig-name descname"><span class="pre">GamsphPipe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fdir</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ftag</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doFast</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uID</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Inner'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doParallel</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nWorkers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe" title="Permalink to this definition"></a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">GameraPipe</span></code></p>
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.AddTime">
+<span class="sig-name descname"><span class="pre">AddTime</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ax</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[0.9,</span> <span class="pre">0.95]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cLab</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'black'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'medium'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">T0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doBox</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">BoxC</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'lightgrey'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.AddTime" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.EqSlice">
+<span class="sig-name descname"><span class="pre">EqSlice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sID</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vScl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doEq</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doVerb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.EqSlice" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.MerBrNrm">
+<span class="sig-name descname"><span class="pre">MerBrNrm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">(None,</span> <span class="pre">None)</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.MerBrNrm" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.MerDNrm">
+<span class="sig-name descname"><span class="pre">MerDNrm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">(None,</span> <span class="pre">None)</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.MerDNrm" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.MerMagV">
+<span class="sig-name descname"><span class="pre">MerMagV</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">(None,</span> <span class="pre">None)</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.MerMagV" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.MerTemp">
+<span class="sig-name descname"><span class="pre">MerTemp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">(None,</span> <span class="pre">None)</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.MerTemp" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.MeridGrid">
+<span class="sig-name descname"><span class="pre">MeridGrid</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.MeridGrid" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.MeridGridHalfs">
+<span class="sig-name descname"><span class="pre">MeridGridHalfs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">kidx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">phi</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.MeridGridHalfs" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.MeridSlice">
+<span class="sig-name descname"><span class="pre">MeridSlice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sID</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vScl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doVerb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">(None,</span> <span class="pre">None)</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.MeridSlice" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.OpenPipe">
+<span class="sig-name descname"><span class="pre">OpenPipe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">doVerbose</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.OpenPipe" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.RadProfDen">
+<span class="sig-name descname"><span class="pre">RadProfDen</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.RadProfDen" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.RadProfFlux">
+<span class="sig-name descname"><span class="pre">RadProfFlux</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.RadProfFlux" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.RadProfSpeed">
+<span class="sig-name descname"><span class="pre">RadProfSpeed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.RadProfSpeed" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.RadialProfileGrid">
+<span class="sig-name descname"><span class="pre">RadialProfileGrid</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.RadialProfileGrid" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.RadialProfileVar">
+<span class="sig-name descname"><span class="pre">RadialProfileVar</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sID</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vScl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doVerb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.RadialProfileVar" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.bStream">
+<span class="sig-name descname"><span class="pre">bStream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xyBds</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[-35,</span> <span class="pre">25,</span> <span class="pre">-25,</span> <span class="pre">25]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.05</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.bStream" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.eqBx">
+<span class="sig-name descname"><span class="pre">eqBx</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.eqBx" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.eqBy">
+<span class="sig-name descname"><span class="pre">eqBy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.eqBy" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.eqBz">
+<span class="sig-name descname"><span class="pre">eqBz</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.eqBz" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.eqMagV">
+<span class="sig-name descname"><span class="pre">eqMagV</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.eqMagV" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.eqNormBr">
+<span class="sig-name descname"><span class="pre">eqNormBr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.eqNormBr" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.eqNormD">
+<span class="sig-name descname"><span class="pre">eqNormD</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.eqNormD" title="Permalink to this definition"></a></dt>
+<dd><p>Compute the normalized number density in the equatorial plane.</p>
+<p>Compute the normalized number density in the equatorial plane.</p>
+<p>The number density is normalized by the factor (r/r0)**2, where r0 is
+the radius of the inner edge of the grid (should be 21.5 Rsun).</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>self</strong> (<a class="reference internal" href="#gamhelio.heliosphere.GamsphPipe" title="gamhelio.heliosphere.GamsphPipe"><em>GamsphPipe</em></a>) – This object</p></li>
+<li><p><strong>s0</strong> (<em>int</em>) – Simulation step number to fetch</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><strong>NormDeq</strong> – Normalized number density in equatorial plane</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>np.ndarray, shape same as self.xxc</p>
+</dd>
+<dt class="field-even">Raises<span class="colon">:</span></dt>
+<dd class="field-even"><p><strong>None</strong> – </p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.eqTemp">
+<span class="sig-name descname"><span class="pre">eqTemp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.eqTemp" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.iSliceBr">
+<span class="sig-name descname"><span class="pre">iSliceBr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">idx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.iSliceBr" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.iSliceBrBound">
+<span class="sig-name descname"><span class="pre">iSliceBrBound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">idx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.iSliceBrBound" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.iSliceBx">
+<span class="sig-name descname"><span class="pre">iSliceBx</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">idx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.iSliceBx" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.iSliceBy">
+<span class="sig-name descname"><span class="pre">iSliceBy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">idx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.iSliceBy" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.iSliceBz">
+<span class="sig-name descname"><span class="pre">iSliceBz</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">idx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.iSliceBz" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.iSliceD">
+<span class="sig-name descname"><span class="pre">iSliceD</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">idx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.iSliceD" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.iSliceGrid">
+<span class="sig-name descname"><span class="pre">iSliceGrid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">idx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.iSliceGrid" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.iSliceMagV">
+<span class="sig-name descname"><span class="pre">iSliceMagV</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">idx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.iSliceMagV" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.iSliceT">
+<span class="sig-name descname"><span class="pre">iSliceT</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">idx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.iSliceT" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.iSliceVar">
+<span class="sig-name descname"><span class="pre">iSliceVar</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sID</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vScl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doVerb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">idx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.iSliceVar" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.jMagV">
+<span class="sig-name descname"><span class="pre">jMagV</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">jidx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.jMagV" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.jNormBr">
+<span class="sig-name descname"><span class="pre">jNormBr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">jidx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.jNormBr" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.jNormD">
+<span class="sig-name descname"><span class="pre">jNormD</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">jidx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.jNormD" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.jSlice">
+<span class="sig-name descname"><span class="pre">jSlice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sID</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vScl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doEq</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doVerb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">jidx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.jSlice" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.jTemp">
+<span class="sig-name descname"><span class="pre">jTemp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">jidx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.jTemp" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.heliosphere.GamsphPipe.vStream">
+<span class="sig-name descname"><span class="pre">vStream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xyBds</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[-35,</span> <span class="pre">25,</span> <span class="pre">-25,</span> <span class="pre">25]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.05</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.heliosphere.GamsphPipe.vStream" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</section>
+<section id="module-gamhelio">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-gamhelio" title="Permalink to this heading"></a></h2>
+</section>
+</section>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="gamera.html" class="btn btn-neutral float-left" title="gamera package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="gamhelio.lib.html" class="btn btn-neutral float-right" title="gamhelio.lib package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, Center for Geospace Storms.</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>

docs/build/html/gamhelio.lib.html

@@ -0,0 +1,252 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en">
+<head>
+  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>gamhelio.lib package &mdash; Kaipy 1.0.0 documentation</title>
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
+
+  
+  <!--[if lt IE 9]>
+    <script src="_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+  
+        <script src="_static/jquery.js"></script>
+        <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
+        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
+        <script src="_static/doctools.js"></script>
+        <script src="_static/sphinx_highlight.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" />
+    <link rel="next" title="gamhelio.wsa2TDgamera package" href="gamhelio.wsa2TDgamera.html" />
+    <link rel="prev" title="gamhelio package" href="gamhelio.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">
+            Kaipy
+          </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">Contents:</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="modules.html">kaipy</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="cdaweb_utils.html">cdaweb_utils module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="chimp.html">chimp package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="embiggenUtils.html">embiggenUtils module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="gamera.html">gamera package</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="gamhelio.html">gamhelio package</a><ul class="current">
+<li class="toctree-l3 current"><a class="reference internal" href="gamhelio.html#subpackages">Subpackages</a><ul class="current">
+<li class="toctree-l4 current"><a class="current reference internal" href="#">gamhelio.lib package</a></li>
+<li class="toctree-l4"><a class="reference internal" href="gamhelio.wsa2TDgamera.html">gamhelio.wsa2TDgamera package</a></li>
+<li class="toctree-l4"><a class="reference internal" href="gamhelio.wsa2gamera.html">gamhelio.wsa2gamera package</a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="gamhelio.html#submodules">Submodules</a></li>
+<li class="toctree-l3"><a class="reference internal" href="gamhelio.html#gamhelio-helioviz-module">gamhelio.helioViz module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="gamhelio.html#module-gamhelio.heliosphere">gamhelio.heliosphere module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="gamhelio.html#module-gamhelio">Module contents</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="kJobs.html">kJobs module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaiH5.html">kaiH5 module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaiTools.html">kaiTools module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaiViz.html">kaiViz module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaijson.html">kaijson module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kaixdmf.html">kaixdmf module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="kdefs.html">kdefs module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="lfm2kaiju.html">lfm2kaiju module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="paraview.html">paraview package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rcm.html">rcm package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="remix.html">remix package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="solarWind.html">solarWind package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="supermag_api.html">supermag_api module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="supermage.html">supermage module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="transform.html">transform module</a></li>
+</ul>
+</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">Kaipy</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="modules.html">kaipy</a></li>
+          <li class="breadcrumb-item"><a href="gamhelio.html">gamhelio package</a></li>
+      <li class="breadcrumb-item active">gamhelio.lib package</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="_sources/gamhelio.lib.rst.txt" rel="nofollow"> View page source</a>
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+             
+  <section id="gamhelio-lib-package">
+<h1>gamhelio.lib package<a class="headerlink" href="#gamhelio-lib-package" title="Permalink to this heading"></a></h1>
+<section id="submodules">
+<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
+</section>
+<section id="module-gamhelio.lib.ace">
+<span id="gamhelio-lib-ace-module"></span><h2>gamhelio.lib.ace module<a class="headerlink" href="#module-gamhelio.lib.ace" title="Permalink to this heading"></a></h2>
+<dl class="py function">
+<dt class="sig sig-object py" id="gamhelio.lib.ace.cdaweb_mfi">
+<span class="sig-prename descclassname"><span class="pre">gamhelio.lib.ace.</span></span><span class="sig-name descname"><span class="pre">cdaweb_mfi</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ACE_mf_file</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.lib.ace.cdaweb_mfi" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamhelio.lib.ace.cdaweb_swe">
+<span class="sig-prename descclassname"><span class="pre">gamhelio.lib.ace.</span></span><span class="sig-name descname"><span class="pre">cdaweb_swe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ACE_plasma_file</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.lib.ace.cdaweb_swe" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+</section>
+<section id="module-gamhelio.lib.cspice">
+<span id="gamhelio-lib-cspice-module"></span><h2>gamhelio.lib.cspice module<a class="headerlink" href="#module-gamhelio.lib.cspice" title="Permalink to this heading"></a></h2>
+<dl class="py function">
+<dt class="sig sig-object py" id="gamhelio.lib.cspice.cspice">
+<span class="sig-prename descclassname"><span class="pre">gamhelio.lib.cspice.</span></span><span class="sig-name descname"><span class="pre">cspice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fname</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.lib.cspice.cspice" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+</section>
+<section id="gamhelio-lib-lfmhlib-module">
+<h2>gamhelio.lib.lfmhlib module<a class="headerlink" href="#gamhelio-lib-lfmhlib-module" title="Permalink to this heading"></a></h2>
+</section>
+<section id="gamhelio-lib-mas-module">
+<h2>gamhelio.lib.mas module<a class="headerlink" href="#gamhelio-lib-mas-module" title="Permalink to this heading"></a></h2>
+</section>
+<section id="module-gamhelio.lib.msgr">
+<span id="gamhelio-lib-msgr-module"></span><h2>gamhelio.lib.msgr module<a class="headerlink" href="#module-gamhelio.lib.msgr" title="Permalink to this heading"></a></h2>
+<dl class="py function">
+<dt class="sig sig-object py" id="gamhelio.lib.msgr.msgr">
+<span class="sig-prename descclassname"><span class="pre">gamhelio.lib.msgr.</span></span><span class="sig-name descname"><span class="pre">msgr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msgr_file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ave_1h</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.lib.msgr.msgr" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamhelio.lib.msgr.msgr_v1">
+<span class="sig-prename descclassname"><span class="pre">gamhelio.lib.msgr.</span></span><span class="sig-name descname"><span class="pre">msgr_v1</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msgr_file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">year</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.lib.msgr.msgr_v1" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+</section>
+<section id="module-gamhelio.lib.poisson">
+<span id="gamhelio-lib-poisson-module"></span><h2>gamhelio.lib.poisson module<a class="headerlink" href="#module-gamhelio.lib.poisson" title="Permalink to this heading"></a></h2>
+<dl class="py class">
+<dt class="sig sig-object py" id="gamhelio.lib.poisson.poisson">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">gamhelio.lib.poisson.</span></span><span class="sig-name descname"><span class="pre">poisson</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">theta</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">phi</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.lib.poisson.poisson" title="Permalink to this definition"></a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.lib.poisson.poisson.residual">
+<span class="sig-name descname"><span class="pre">residual</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">P</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lhs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.lib.poisson.poisson.residual" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.lib.poisson.poisson.residual_xsin2">
+<span class="sig-name descname"><span class="pre">residual_xsin2</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">P</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lhs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.lib.poisson.poisson.residual_xsin2" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="gamhelio.lib.poisson.poisson.setRHS">
+<span class="sig-name descname"><span class="pre">setRHS</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">RHS</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.lib.poisson.poisson.setRHS" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</section>
+<section id="module-gamhelio.lib.util">
+<span id="gamhelio-lib-util-module"></span><h2>gamhelio.lib.util module<a class="headerlink" href="#module-gamhelio.lib.util" title="Permalink to this heading"></a></h2>
+<dl class="py function">
+<dt class="sig sig-object py" id="gamhelio.lib.util.radial_interp">
+<span class="sig-prename descclassname"><span class="pre">gamhelio.lib.util.</span></span><span class="sig-name descname"><span class="pre">radial_interp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vars_from</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">var_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">radii_to</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coef_label</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'r_interp_coefs'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ind_label</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'r_interp_above_ind'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.lib.util.radial_interp" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamhelio.lib.util.sph2cart">
+<span class="sig-prename descclassname"><span class="pre">gamhelio.lib.util.</span></span><span class="sig-name descname"><span class="pre">sph2cart</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">a</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">theta</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">phi</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.lib.util.sph2cart" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+</section>
+<section id="module-gamhelio.lib.wsa">
+<span id="gamhelio-lib-wsa-module"></span><h2>gamhelio.lib.wsa module<a class="headerlink" href="#module-gamhelio.lib.wsa" title="Permalink to this heading"></a></h2>
+<dl class="py function">
+<dt class="sig sig-object py" id="gamhelio.lib.wsa.info">
+<span class="sig-prename descclassname"><span class="pre">gamhelio.lib.wsa.</span></span><span class="sig-name descname"><span class="pre">info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">wsa_file</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.lib.wsa.info" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamhelio.lib.wsa.plot">
+<span class="sig-prename descclassname"><span class="pre">gamhelio.lib.wsa.</span></span><span class="sig-name descname"><span class="pre">plot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">wsa_file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">savefig</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.lib.wsa.plot" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="gamhelio.lib.wsa.read">
+<span class="sig-prename descclassname"><span class="pre">gamhelio.lib.wsa.</span></span><span class="sig-name descname"><span class="pre">read</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">wsa_file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">densTempInfile</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">normalized</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gamhelio.lib.wsa.read" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
+</section>
+<section id="module-gamhelio.lib.wsa2h5">
+<span id="gamhelio-lib-wsa2h5-module"></span><h2>gamhelio.lib.wsa2h5 module<a class="headerlink" href="#module-gamhelio.lib.wsa2h5" title="Permalink to this heading"></a></h2>
+</section>
+<section id="module-gamhelio.lib">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-gamhelio.lib" title="Permalink to this heading"></a></h2>
+</section>
+</section>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="gamhelio.html" class="btn btn-neutral float-left" title="gamhelio package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="gamhelio.wsa2TDgamera.html" class="btn btn-neutral float-right" title="gamhelio.wsa2TDgamera package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, Center for Geospace Storms.</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>