Job: Add progress bar

CHANGELOG.md

@@ -3,6 +3,9 @@ All notable changes to this project will be documented in this file. The format
 
 ## [Unreleased]
 
+### Changed
+- Show a progress bar during `Job.evaluate(verbose=True)`. The old output is available with `verbose=2`.
+
 ### Removed
 - Remove config files for MyBinder. They are now located in a different repository [adtzlr/felupe-web](https://github.com/adtzlr/felupe-web).
 

README.md

@@ -25,6 +25,7 @@ In order to make use of all features of FElupe, it is suggested to install all o
 * `matplotlib` for plotting graphs
 * `meshio` for mesh-related I/O
 * `pyvista` for interactive visualizations
+* `tqdm` for showing progress bars during job evaluation
 
 # Getting Started
 This tutorial covers the essential high-level parts of creating and solving problems with FElupe. As an introductory example, a quarter model of a solid cube with hyperelastic material behaviour is subjected to a uniaxial elongation applied at a clamped end-face. 

docs/index.rst

@@ -57,7 +57,7 @@ Another key feature is the easy and straightforward definition of mixed field fo
 Installation
 ------------
 
-Install Python, open the terminal and run ``pip install felupe[all]``, where ``[all]`` installs all optional dependencies. By default, FElupe depends on ``numpy``, ``scipy`` and ``tensortrax``. However,  ``einsumt``, ``h5py``, ``matplotlib``, ``meshio`` and ``pyvista`` are highly recommended. In order to make use of all features of FElupe, it is suggested to install all optional dependencies. For more flexible constitutive material definitions using Automatic Differentiation consider also installing `matADi <https://github.com/adtzlr/matadi>`_.
+Install Python, open the terminal and run ``pip install felupe[all]``, where ``[all]`` installs all optional dependencies. By default, FElupe depends on ``numpy``, ``scipy`` and ``tensortrax``. However,  ``einsumt``, ``h5py``, ``matplotlib``, ``meshio``, ``pyvista`` and ``tqdm`` are highly recommended. In order to make use of all features of FElupe, it is suggested to install all optional dependencies. For more flexible constitutive material definitions using Automatic Differentiation consider also installing `matADi <https://github.com/adtzlr/matadi>`_.
 
 .. code-block:: shell
 

pyproject.toml

@@ -52,7 +52,6 @@ test = [
     "h5py",
     "matplotlib",
     "meshio",
-    "pyvista",
     "tensortrax",
 ]
 all = [
@@ -61,6 +60,8 @@ all = [
     "matplotlib",
     "meshio",
     "tensortrax",
+    "pyvista",
+    "tqdm",
 ]
 
 [tool.setuptools.dynamic]

src/felupe/mechanics/_job.py

@@ -55,6 +55,29 @@ def log_strain(field, substep=None):
     return [tovoigt(strain.mean(-2), True).T]
 
 
+def header(verbose):
+    if verbose == 1:
+        return "\n".join([
+            f"FElupe Version {version}",
+            f"{platform(terse=True)} {machine()} {architecture()[0]}",
+            "",
+        ])
+    elif verbose > 1:
+        return f"""
+ _______  _______  ___      __   __  _______  _______
+|       ||       ||   |    |  | |  ||       ||       |
+|    ___||    ___||   |    |  | |  ||    _  ||    ___|
+|   |___ |   |___ |   |    |  |_|  ||   |_| ||   |___
+|    ___||    ___||   |___ |       ||    ___||    ___|
+|   |    |   |___ |       ||       ||   |    |   |___
+|___|    |_______||_______||_______||___|    |_______|
+FElupe Version {version} ({platform(terse=True)} {machine()} {architecture()[0]})
+
+Run Job
+=======
+"""
+
+
 class Job:
     "A job with a list of steps."
 
@@ -90,30 +113,21 @@ def evaluate(
         parallel=False,
         **kwargs,
     ):
+        try:
+            from tqdm import tqdm
+        except ModuleNotFoundError:
+            verbose = 2
 
         if verbose:
-            print(
-                f"""
- _______  _______  ___      __   __  _______  _______
-|       ||       ||   |    |  | |  ||       ||       |
-|    ___||    ___||   |    |  | |  ||    _  ||    ___|
-|   |___ |   |___ |   |    |  |_|  ||   |_| ||   |___
-|    ___||    ___||   |___ |       ||    ___||    ___|
-|   |    |   |___ |       ||       ||   |    |   |___
-|___|    |_______||_______||_______||___|    |_______|
-FElupe Version {version} ({platform(terse=True)} {machine()} {architecture()[0]})
-
-"""
-            )
-
-            print("Run Job")
-            print("=======\n")
+            print(header(verbose))
 
         if parallel:
             if "kwargs" not in kwargs.keys():
                 kwargs["kwargs"] = {}
             kwargs["kwargs"]["parallel"] = True
 
+        increment = 0
+
         if filename is not None:
             from meshio.xdmf import TimeSeriesWriter
 
@@ -123,8 +137,6 @@ def evaluate(
                 else:
                     mesh = self.steps[0].items[0].field.region.mesh.as_meshio()
 
-            increment = 0
-
             pdata = point_data_default if point_data_default is True else {}
             cdata = cell_data_default if cell_data_default is not None else {}
 
@@ -157,16 +169,22 @@ def evaluate(
             if filename is not None:
                 writer.write_points_cells(mesh.points, mesh.cells)
 
+            if verbose == 1:
+                total = sum([step.nsubsteps for step in self.steps])
+                progress_bar = tqdm(total=total, unit=" substeps")
+
             for j, step in enumerate(self.steps):
 
-                if verbose:
+                newton_verbose = False
+                if verbose == 2:
                     print(f"Begin Evaluation of Step {j + 1}.")
+                    newton_verbose = True
 
-                substeps = step.generate(verbose=verbose, **kwargs)
+                substeps = step.generate(verbose=newton_verbose, **kwargs)
                 for i, substep in enumerate(substeps):
 
-                    if verbose:
-                        _substep = f"Substep {i}/{step.nsubsteps - 1}"
+                    if verbose == 2:
+                        _substep = f"Substep {i + 1}/{step.nsubsteps}"
                         _step = f"Step {j + 1}/{self.nsteps}"
 
                         print(f"{_substep} of {_step} successful.")
@@ -186,4 +204,11 @@ def evaluate(
                             point_data={**pdata, **point_data},
                             cell_data={**cdata, **cell_data},
                         )
-                        increment += 1
+
+                    increment += 1
+
+                    if verbose == 1:
+                        progress_bar.update(1)
+
+            if verbose == 1:
+                progress_bar.close()

tests/test_job.py

@@ -51,7 +51,7 @@ def test_job():
 
     field, step = pre()
     job = fem.Job(steps=[step])
-    job.evaluate(parallel=True, kwargs={"parallel": False})
+    job.evaluate(parallel=True, kwargs={"parallel": False}, verbose=0)
 
 
 def test_job_xdmf():
@@ -62,7 +62,7 @@ def test_job_xdmf():
 
     field, step = pre()
     job = fem.Job(steps=[step])
-    job.evaluate(filename="result.xdmf", parallel=True)
+    job.evaluate(filename="result.xdmf", parallel=True, verbose=2)
 
 
 def test_job_xdmf_global_field():

tox.ini

@@ -7,9 +7,9 @@ deps =
     pytest
     pytest-cov
     matplotlib
-extras = test
+extras = all
 commands =
     pytest {posargs}
 
-[testenv:all]
-extras = all
+[testenv:test]
+extras = test