deploy: 72a3a5b

.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: d668ec34cc48c7570a30fdb4e6373d49
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/api.md.txt

@@ -0,0 +1,37 @@
+# API reference
+
+## Data
+
+```{eval-rst}
+.. automodule:: src.data
+    :members:
+    :undoc-members:
+    :show-inheritance:
+```
+
+## Models
+
+```{eval-rst}
+.. automodule:: src.model
+    :members:
+    :undoc-members:
+    :show-inheritance:
+```
+
+## Config
+
+```{eval-rst}
+.. automodule:: src.config
+    :members:
+    :undoc-members:
+    :show-inheritance:
+```
+
+## Utils
+
+```{eval-rst}
+.. automodule:: src.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+```

_sources/index.rst.txt

@@ -0,0 +1,82 @@
+Welcome to the documentation of the OSIS Reproducability Python Template!
+===============================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+   :glob:
+
+   source/*
+
+|Latest Version| |Python 3.10+| |Documentation| |Code Style Black|
+|codecov| |License| |GitHub|
+
+This Project contains an example python package for the Advanced
+Reproducibility Workshop (OSIS).
+
+Introduction
+------------
+
+Hi there! Here is the right place for a brief introduction to the
+project. The Documentation is available
+`here <https://datascience-lmu.github.io/osis_python_repro/>`__.
+
+   The random project logo was created with Stable Diffusion 2 (Rombach
+   et al., 2022).
+
+Installation
+------------
+
+-  Setup a virtual environment with ``python -m venv venv``
+-  Activate the virtual environment with ``source venv/bin/activate``
+-  Install the project with poetry ``poetry install`` (Have poetry
+   installed)
+
+Usage
+-----
+
+Populate this section with instructions on how to use the project.
+
+Development Setup
+-----------------
+
+-  Install pre-commit hooks with ``pre-commit install``
+-  Run tests with ``unittest`` with
+   ``python -m unittest discover -s tests``
+
+Contribution Guidelines
+-----------------------
+
+Populate this section with guidelines on how to contribute to the
+project.
+
+Citation
+--------
+
+If you use this project, please cite it as follows:
+
+::
+
+   @misc{osisPyRepr2024,
+     author = {Emanuel Sommer and Tobias Weber and Lisa Wimmer},
+     title = {Advanced Reproducibility Workshop - Python Package Template},
+     year = {2024},
+   }
+
+License
+-------
+
+This project is licensed under the MIT License - see the
+`LICENSE <LICENSE>`__ file for details.
+
+.. |Latest Version| image:: https://img.shields.io/badge/version-0.1.0-g
+.. |Python 3.10+| image:: https://img.shields.io/badge/python-3.10%2C%203.11%2C%203.12-blue?logo=python
+.. |Documentation| image:: https://img.shields.io/badge/documentation-view-blue?logo=read-the-docs
+   :target: https://datascience-lmu.github.io/osis_python_repro/
+.. |Code Style Black| image:: https://img.shields.io/badge/code%20style-black-black
+.. |codecov| image:: https://codecov.io/gh/DataScience-LMU/osis_python_repro/graph/badge.svg?token=DTLY6DO9OG
+   :target: https://codecov.io/gh/DataScience-LMU/osis_python_repro
+.. |License| image:: https://img.shields.io/badge/license-MIT-green
+   :target: LICENSE
+.. |GitHub| image:: https://img.shields.io/badge/GitHub-View%20on%20GitHub-lightgrey?logo=github
+   :target: https://github.com/DataScience-LMU/osis_python_repro

_sources/source/modules.rst.txt

@@ -0,0 +1,7 @@
+src
+===
+
+.. toctree::
+   :maxdepth: 4
+
+   src

_sources/source/src.rst.txt

@@ -0,0 +1,37 @@
+src package
+===========
+
+Submodules
+----------
+
+src.config module
+-----------------
+
+.. automodule:: src.config
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+src.data module
+---------------
+
+.. automodule:: src.data
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+src.model module
+----------------
+
+.. automodule:: src.model
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+src.utils module
+----------------
+
+.. automodule:: src.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:

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