Made logging an option that can be enabled by the initiate_logger fun…

…ction

docs/api.rst

@@ -5,4 +5,6 @@ API Documentation
 .. autosummary::
    :toctree: _autosummary
 
+   initiate_logger
    multipole_mie_combining_rules
+

mapsci/__init__.py

@@ -12,3 +12,46 @@
 __version__ = versions['version']
 __git_revision__ = versions['full-revisionid']
 del get_versions, versions
+
+import logging
+import logging.handlers
+import os
+
+logger = logging.getLogger()
+logger.setLevel(30)
+
+def initiate_logger(console=False, log_file=None, verbose=30):
+    """
+    Initiate a logging handler if more detail on the calculations is desired.
+
+    Parameters
+    ----------
+    console : bool, Optional, default=False
+        Initiates a stream handler to print to a console
+    log_file : bool/str, Optional, default=None
+        If log output should be recorded in a file, set this keyword to either True or to a name for the log file. If True, the file name 'mapsci.log' is used. Note that if a file with the same name already exists, it will be deleted.
+    verbose : int, Optional, default=30
+        The verbosity of logging information can be set to any supported representation of the `logging level <https://docs.python.org/3/library/logging.html#logging-levels>`_.  
+    """
+
+    logger.setLevel(verbose)
+
+    if console:
+        # Set up logging to console
+        console_handler = logging.StreamHandler() # sys.stderr
+        console_handler.setFormatter( logging.Formatter('[%(levelname)s](%(name)s): %(message)s') )
+        console_handler.setLevel(verbose)
+        logger.addHandler(console_handler)
+
+    if log_file is not None:
+
+        if type(log_file) != str:
+            log_file = "mapsci.log"
+
+        if os.path.isfile(log_file):
+            os.remove(log_file)
+
+        log_file_handler = logging.handlers.RotatingFileHandler(log_file)
+        log_file_handler.setFormatter( logging.Formatter('%(asctime)s [%(levelname)s](%(name)s:%(funcName)s:%(lineno)d): %(message)s') )
+        log_file_handler.setLevel(verbose)
+        logger.addHandler(log_file_handler)