deploy: c197196

_sources/about.rst.txt

@@ -0,0 +1,8 @@
+.. about credits, etc
+
+
+Credits
+=======
+
+The pilot version of this automatic documentation was constructed by Sameli Siljamo during his two-week work-life trainee period.
+

_sources/biot_savart.rst.txt

@@ -0,0 +1,5 @@
+biot_savart
+-----------
+
+.. automodule:: biot_savart
+	:members:

_sources/calculations.rst.txt

@@ -0,0 +1,6 @@
+calculations
+=================================
+
+.. automodule:: pytools.calculations
+   :members:
+   :imported-members:

_sources/gics.rst.txt

@@ -0,0 +1,5 @@
+gics
+----
+
+.. automodule:: gics
+	:members:

_sources/index.rst.txt

@@ -0,0 +1,40 @@
+.. analysator documentation master file, created by
+   sphinx-quickstart on Tue Oct 29 10:43:26 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+analysator documentation
+========================
+
+.. .. image:: logo_color.png
+..    :height: 37
+..    :width: 300
+..    :scale: 75
+..    :align: right
+..    :alt: Vlasiator Logo
+
+`Analysator <https://github.com/fmihpc/analysator>`_ is a set of Python tools and scripts used to read and analyze `Vlasiator <https://github.com/fmihpc/vlasiator>`_ output files (`VLSV <https://github.com/fmihpc/vlsv>`_). Vlasiator and its related tools are developed at `University of Helsinki <https://www.helsinki.fi/en/researchgroups/vlasiator>`_, and are open source. 
+
+
+This documentation is generated via Sphinx-autodoc from Analysator source. This page is a work in progress, with docstrings and the documentation layout in flux. Contributions via Analysator repo are welcome.
+
+Add your content using ``reStructuredText`` syntax. See the
+`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
+documentation for details.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   plot
+   calculations
+   vlsvfile
+   miscellaneous
+   scripts
+   about
+
+.. automodule:: pytools 
+   :members:
+   :imported-members:
+   :undoc-members:
+

_sources/magnetopause2d.rst.txt

@@ -0,0 +1,5 @@
+magnetopause2d
+--------------
+
+.. automodule:: magnetopause2d
+	:members:

_sources/magnetopause3d.rst.txt

@@ -0,0 +1,5 @@
+magnetopause3d
+--------------
+
+.. automodule:: magnetopause3d
+	:members:

_sources/miscellaneous.rst.txt

@@ -0,0 +1,6 @@
+miscellaneous
+==================================
+
+.. automodule:: pytools.miscellaneous
+   :members:
+   :imported-members:

_sources/plot.rst.txt

@@ -0,0 +1,8 @@
+plot
+============================
+
+.. automodule:: pytools.plot
+   :members:
+   :exclude-members: Version
+   :imported-members:
+

_sources/scripts.rst.txt

@@ -0,0 +1,70 @@
+scripts
+=====================
+
+Scripts are not included in the main Analysator module import; instead, these are separate scripts utilising Analysator to some purpose.
+
+biot_savart
+-----------
+:doc:`biot_savart`
+
+.. automodule:: biot_savart
+    :no-index:
+
+------------
+
+gics
+----
+:doc:`gics`
+
+.. automodule:: gics
+    :no-index:
+
+------------
+
+magnetopause2d
+--------------
+:doc:`magnetopause2d`
+
+.. automodule:: magnetopause2d
+    :no-index:
+
+------------
+
+magnetopause3d
+--------------
+:doc:`magnetopause3d`
+
+.. automodule:: magnetopause3d
+    :no-index:
+
+------------
+
+shue
+--------------
+:doc:`shue`
+
+.. automodule:: shue
+    :no-index:
+
+------------
+
+tsyganenko
+--------------
+:doc:`tsyganenko`
+
+.. automodule:: tsyganenko
+    :no-index:
+
+------------
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Scripts:
+
+   biot_savart
+   gics
+   magnetopause2d
+   magnetopause3d
+   shue
+   tsyganenko
+

_sources/shue.rst.txt

@@ -0,0 +1,5 @@
+shue
+----
+
+.. automodule:: shue
+	:members:

_sources/tsyganenko.rst.txt

@@ -0,0 +1,5 @@
+tsyganenko
+----------
+
+.. automodule:: tsyganenko
+	:members:

_sources/vlsvfile.rst.txt

@@ -0,0 +1,8 @@
+vlsvfile
+============================
+
+VlsvFile is responsibe for implementing read and write functionality for the vlsv format, as well as defining data reducers and reduction pipelines. Some of this will be likely moved around to be more modular in some indefinite point in the future.
+
+.. automodule:: pytools.vlsvfile
+   :members:
+   :imported-members:

_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;
+}