Merge branch '372-silent-library' into 'development'

logging allows users to conveniently silence info output when running scripts with the library

Closes #372

See merge request damask/DAMASK!1024

Author: MarDiehl

python/damask/__init__.py

@@ -10,6 +10,9 @@
 
 from pathlib import Path as _Path
 import re as _re
+import logging
+
+logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')
 
 name = 'damask'
 with open(_Path(__file__).parent/_Path('VERSION')) as _f:

python/damask/_configmaterial.py

@@ -2,15 +2,18 @@
 
 import numpy as np
 import h5py
+import logging
 
-from ._typehints import FloatSequence, StrSequence
 from . import YAML
 from . import Rotation
 from . import Orientation
 from . import util
 from . import tensor
 from . import Table
+from ._typehints import FloatSequence, StrSequence
+
 
+logger = logging.getLogger(__name__)
 
 class ConfigMaterial(YAML):
     """
@@ -312,7 +315,7 @@ def LabeledList(label,items):
                     msg.append(f'{LabeledList(v,_empty)} undefined')
                     ok = False
 
-        print(util.srepr(msg))
+        logger.info(util.srepr(msg))
         return ok
 
 
@@ -339,7 +342,7 @@ def is_valid(self) -> bool:
                     try:
                         Orientation(lattice=v['lattice'])
                     except KeyError:
-                        print(f"Invalid lattice '{v['lattice']}' in phase '{k}'")
+                        logger.warning(f"Invalid lattice '{v['lattice']}' in phase '{k}'")
                         ok = False
 
         if 'material' in self:
@@ -352,10 +355,10 @@ def is_valid(self) -> bool:
                             try:
                                 Rotation.from_quaternion(c['O'])
                             except ValueError:
-                                print(f"Invalid orientation '{c['O']}' in material '{i}'")
+                                logger.warning(f"Invalid orientation '{c['O']}' in material '{i}'")
                                 ok = False
                     if not np.isclose(v,1.0):
-                        print(f"Total fraction v = {v} ≠ 1 in material '{i}'")
+                        logger.warning(f"Total fraction v = {v} ≠ 1 in material '{i}'")
                         ok = False
 
         return ok

python/damask/_geomgrid.py

@@ -22,10 +22,10 @@
 except ImportError:
     nb = False
 
+
 def numba_njit_wrapper(**kwargs):
     return (lambda function: nb.njit(function) if nb else function)
 
-
 class GeomGrid:
     """
     Geometry definition for grid solvers.

python/damask/_result.py

@@ -14,6 +14,7 @@
 import numpy as np
 from numpy import ma
 from scipy import interpolate
+import logging
 
 import damask
 from . import VTK
@@ -26,6 +27,8 @@
 from ._typehints import FloatSequence, IntSequence, DADF5Dataset, BravaisLattice
 
 
+logger = logging.getLogger(__name__)
+
 chunk_size = 1024**2//8                                                                             # for compression in HDF5
 
 prefix_inc = 'increment_'
@@ -358,7 +361,7 @@ def view(self,*,
         dup = self._manage_view('set',increments,times,phases,homogenizations,fields)
         if protected is not None:
             if not protected:
-                print(util.warn('Warning: Modification of existing datasets allowed!'))
+                logger.warning(util.warn('Modification of existing datasets allowed!'))
             dup._protected = protected
 
         return dup
@@ -572,7 +575,7 @@ def list_data(self) -> List[str]:
     def enable_user_function(self,
                              func: Callable):
         globals()[func.__name__]=func
-        print(f'Function {func.__name__} enabled in add_calculation.')
+        logger.info(f'Function {func.__name__} enabled in add_calculation.')
 
 
     @property
@@ -1539,7 +1542,7 @@ def job_pointwise(group: str,
                                           'meta': {k: v for k,v in loc.attrs.items()}}
                 return callback(**datasets_in,**args)
             except Exception as err:
-                print(f'Error during calculation: {err}.')
+                logger.error(f'Error during pointwise calculation: {err}.')
                 return None
 
         groups = []
@@ -1552,7 +1555,7 @@ def job_pointwise(group: str,
                             if set(datasets.values()).issubset(f[group].keys()): groups.append(group)
 
         if len(groups) == 0:
-            print('No matching dataset found, no data was added.')
+            logger.warning('No matching dataset found, no data was added.')
             return
 
 
@@ -1585,7 +1588,7 @@ def job_pointwise(group: str,
                     dataset.attrs['creator'] = f'damask.Result.{creator} v{damask.version}'
 
                 except (OSError,RuntimeError) as err:
-                    print(f'Could not add dataset: {err}.')
+                    logger.error(f'Could not add dataset: {err}.')
 
 
     def _mappings(self) -> MappingsTuple:

python/damask/_table.py

@@ -8,6 +8,7 @@
 from ._typehints import FileHandle
 from . import util
 
+
 class Table:
     """Manipulate multi-dimensional spreadsheet-like data."""
 

python/damask/_vtk.py

@@ -1,6 +1,7 @@
 import os
 import multiprocessing as mp
 from pathlib import Path
+import logging
 from typing import Optional, Union, Literal, List, Sequence
 
 import numpy as np
@@ -62,6 +63,8 @@
 from . import Colormap
 
 
+logger = logging.getLogger(__name__)
+
 class VTK:
     """
     Spatial visualization (and potentially manipulation).
@@ -685,7 +688,7 @@ def show(self,
         iren = vtkRenderWindowInteractor()
         iren.SetRenderWindow(window)
         if os.name == 'posix' and 'DISPLAY' not in os.environ:
-            print('Found no rendering device')
+            logger.warning('Found no rendering device')
         else:
             window.Render()
             iren.Start()

python/damask/solver/_marc.py

@@ -2,8 +2,12 @@
 import shlex
 import re
 from pathlib import Path
+import logging
 from typing import Literal
 
+
+logger = logging.getLogger(__name__)
+
 _marc_version = '2024.1'
 _marc_root = '/opt/msc'
 _damask_root = str(Path(__file__).parents[3])
@@ -92,7 +96,7 @@ def submit_job(self, model: str, job: str,
                f'-nprocd {domains} -nsolver {domains} -nthread_elem {domains} -nthread_solver {domains} ')\
             + '-autorst 0 -ci n -cr n -dcoup 0 -b no -v no '\
             + (f'-u {usersub} -save y' if compile else f'-prog {usersub.with_suffix("")}')
-        print(cmd)
+        logger.info(cmd)
 
         ret = subprocess.run(shlex.split(cmd),capture_output=True,env=env)
 

python/damask/util.py

@@ -12,10 +12,11 @@
 from collections import abc as _abc, OrderedDict as _OrderedDict
 from functools import reduce as _reduce, partial as _partial, wraps as _wraps
 import inspect
+from pathlib import Path as _Path
+import logging
 from typing import Optional as _Optional, Callable as _Callable, Union as _Union, Iterable as _Iterable, \
                    Dict as _Dict, List as _List, Tuple as _Tuple, Literal as _Literal, NamedTuple as _NamedTuple, \
                    Any as _Any, TextIO as _TextIO, Generator as _Generator
-from pathlib import Path as _Path
 
 import numpy as _np
 import h5py as _h5py
@@ -29,6 +30,8 @@ class stdioTuple(_NamedTuple):
     stdout: str
 
 
+logger = logging.getLogger(__name__)
+
 # https://svn.blender.org/svnroot/bf-blender/trunk/blender/build_files/scons/tools/bcolors.py
 # https://stackoverflow.com/questions/287871
 _colors = {
@@ -177,7 +180,7 @@ def pass_signal(sig,_,proc,default):
 
     signals = [_signal.SIGINT,_signal.SIGTERM]
 
-    print(f"running '{cmd}' in '{wd}'")
+    logger.info(f"running '{cmd}' in '{wd}'")
     process = _subprocess.Popen(_shlex.split(cmd),
                                 stdout = _subprocess.PIPE,
                                 stderr = _subprocess.PIPE,
@@ -194,8 +197,8 @@ def pass_signal(sig,_,proc,default):
             _signal.signal(sig,state)
 
     if process.returncode != 0:
-        print(stdout)
-        print(stderr)
+        logger.error(stdout)
+        logger.error(stderr)
         raise RuntimeError(f"'{cmd}' failed with returncode {process.returncode}")
 
     return stdioTuple(stdout, stderr)