Added docstring and renamed function

tardis-sn · Jun 14, 2021 · 6042872 · 6042872
1 parent da87271
commit 6042872
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/tardis/util/base.py b/tardis/util/base.py
@@ -542,7 +542,15 @@ def convert_abundances_format(fname, delimiter=r"\s+"):
     return df
 
 
-def check_notebook():
+def check_simulation_env():
+    """
+    Checks for the Simulation Environment
+
+    Returns
+    -------
+    True : if the environment is IPython Based
+    False : if the environment is Terminal or anything else
+    """
     try:
         shell = get_ipython().__class__.__name__
         if shell == "ZMQInteractiveShell":