Added utils folder from TRTools

gymrek-lab · Apr 8, 2024 · ba87d82 · ba87d82
1 parent 163211a
commit ba87d82
Show file tree

Hide file tree

Showing 11 changed files with 3,952 additions and 0 deletions.
diff --git a/utils/__init__.py b/utils/__init__.py
diff --git a/utils/common.py b/utils/common.py
@@ -0,0 +1,36 @@
+"""
+Common util functions
+"""
+
+import sys
+
+def WARNING(msg):
+    r"""Write a warning message to standard error
+
+    Parameters
+    ----------
+    msg : str
+          A descriptive warning message
+
+    Examples
+    --------
+    >>> WARNING("Something unexpected happened")
+    """
+    sys.stderr.write(msg.strip()+"\n")
+
+def MSG(msg, debug=False):
+    r"""Write a status message to standard error
+
+    Parameters
+    ----------
+    msg : str
+          A descriptive message
+    debug : bool, optional
+          Only print the message if debug is True
+
+    Examples
+    --------
+    >>> MSG("Something unexpected happened")
+    """
+    if debug:
+        sys.stderr.write(msg.strip()+"\n")