Markus test

.codacy.yml

@@ -4,6 +4,11 @@ engines:
     exclude_paths:
       - tests/**
 
+duplication:
+  enabled: true
+  exclude_paths:
+    - tests/**
+
 exclude_paths:
   - 'docs/**'
   - 'scripts/**'

.typo-ci.yml

@@ -27,6 +27,9 @@ excluded_files:
 excluded_words:
   - typoci
   - numpy
+  - scipy
+  - matmul
+  - arange
   - vstack
   - pytest
   - linalg

README.md

@@ -13,4 +13,4 @@
 
 #### Documention
 [![](https://github.com/vhirtham/pythonTest/workflows/pydocstyle/badge.svg)](https://github.com/vhirtham/pythonTest/actions?query=workflow%3A%22pydocstyle%22)
-[![Documentation Status](https://readthedocs.org/projects/rtd-sphinx-theme-sample-project/badge/?version=latest)](https://rtd-sphinx-theme-sample-project.readthedocs.io/en/latest/?badge=latest)
+[![Documentation Status](https://readthedocs.org/projects/vhirthampythontest/badge/?version=latest)](https://vhirthampythontest.readthedocs.io/en/latest/?badge=latest)

codecov.yml

@@ -0,0 +1,36 @@
+codecov:
+  branch: master
+  notify:
+    require_ci_to_pass: yes
+
+coverage:
+  precision: 2
+  round: down
+  range: "70...100"
+
+  status:
+    project:
+      default:
+        enabled: yes
+        target: 85%
+        threshold: 5%
+
+
+    patch:
+      default:
+        enabled: yes
+        target: 85%
+        threshold: 5%
+
+ignore:
+  - "tests"
+  - "*__init__.py"
+
+  #comment:
+  #layout: "reach, diff, flags, files"
+  #behavior: default
+  #require_changes: false  # if true: only post the comment if coverage changes
+  #require_base: no        # [yes :: must have a base report to post]
+  #require_head: yes       # [yes :: must have a head report to post]
+  #branches: null          # branch names that can post comment
+  #after_n_builds: 1 #e.g., 5. The number of uploaded reports codecov will receive before posting a comment on a pull request.

environment.yml

@@ -7,7 +7,7 @@ dependencies:
   - python=3.7
   - numpy=1.17
   - pandas=0.25
-  - scipy=1.3
+  - scipy=1.3.2
   - xarray>=0.12.3
   # - bottleneck>=1.1
   # - jsonschema=2.6

mypackage/_utility.py

@@ -0,0 +1,75 @@
+"""Contains package internal utility functions."""
+
+import math
+import numpy as np
+
+
+def is_column_in_matrix(column, matrix):
+    """
+    Check if a column (1d array) can be found inside of a matrix.
+
+    :param column: Column that should be checked
+    :param matrix: Matrix
+    :return: True or False
+    """
+    return is_row_in_matrix(column, np.transpose(matrix))
+
+
+def is_row_in_matrix(row, matrix):
+    """
+    Check if a row (1d array) can be found inside of a matrix.
+
+    source: https://codereview.stackexchange.com/questions/193835
+
+    :param row: Row that should be checked
+    :param matrix: Matrix
+    :return: True or False
+    """
+    if not matrix.shape[1] == np.array(row).size:
+        return False
+    return (matrix == row).all(axis=1).any()
+
+
+def to_float_array(container):
+    """
+    Cast the passed container to a numpy array of floats.
+
+    :param container: Container which can be cast to a numpy array
+    :return:
+    """
+    return np.array(container, dtype=float)
+
+
+def to_list(var):
+    """
+    Store the passed variable into a list and return it.
+
+    If the variable is already a list, it is returned without modification.
+    If 'None' is passed, the function returns an empty list.
+
+    :param var: Arbitrary variable
+    :return: List
+    """
+    if isinstance(var, list):
+        return var
+    if var is None:
+        return []
+    return [var]
+
+
+def vector_is_close(vec_a, vec_b, abs_tol=1E-9):
+    """
+    Check if a vector is close or equal to another vector.
+
+    :param vec_a: First vector
+    :param vec_b: Second vector
+    :param abs_tol: Absolute tolerance
+    :return: True or False
+    """
+    if not vec_a.size == vec_b.size:
+        return False
+    for i in range(vec_a.size):
+        if not math.isclose(vec_a[i], vec_b[i], abs_tol=abs_tol):
+            return False
+
+    return True