pyroll-core 3.0.0.post4__tar.gz → 3.0.1__tar.gz

{pyroll_core-3.0.0.post4 → pyroll_core-3.0.1}/PKG-INFO

@@ -1,11 +1,12 @@
 Metadata-Version: 2.3
 Name: pyroll-core
-Version: 3.0.0.post4
+Version: 3.0.1
 Summary: PyRoll rolling simulation framework - core library.
 Project-URL: Homepage, https://pyroll-project.github.io
 Project-URL: Repository, https://github.com/pyroll-project/pyroll-core
 Project-URL: Documentation, https://pyroll.readthedocs.io/en/latest
 Author-email: Max Weiner <max.weiner@imf.tu-freiberg.de>, Christoph Renzing <christoph.renzing@imf.tu-freiberg.de>, Matthias Schmidtchen <matthias.schmidtchen@imf.tu-freiberg.de>, Max Stirl <max.stirl@imf.tu-freiberg.de>
+License: BSD-3-Clause
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Framework :: Hatch
 Classifier: Framework :: IPython

{pyroll_core-3.0.0.post4 → pyroll_core-3.0.1}/pyroll/core/__init__.py

@@ -11,9 +11,9 @@ from .rotator import Rotator
 from .sequence import PassSequence
 from .hooks import Hook, HookHost, HookFunction, root_hooks
 from .disk_elements import DiskElementUnit
-from .config import Config, config
+from .config import Config, config, PlottingBackend
 
-VERSION = "3.0.0post4"
+VERSION = "3.0.1"
 
 root_hooks.extend(
     [
@@ -32,6 +32,7 @@ root_hooks.extend(
         BaseRollPass.OutProfile.filling_error,
         BaseRollPass.OutProfile.cross_section_error,
         BaseRollPass.OutProfile.velocity,
+        BaseRollPass.InProfile.velocity,
         PassSequence.log_elongation,
         BaseRollPass.OutProfile.technologically_orientated_cross_section,
         BaseRollPass.technologically_orientated_contour_lines,

{pyroll_core-3.0.0.post4 → pyroll_core-3.0.1}/pyroll/core/config.py

@@ -1,19 +1,20 @@
 import os
+from enum import Enum
 from pathlib import Path
 from typing import Optional, Iterable, Mapping, Any, Callable
 
 
 class ConfigValue:
     """Helper descriptor for storing configuration values, able to determine the value from explictly set values,
-     environment variables and default values."""
+    environment variables and default values."""
 
     def __init__(
-            self,
-            default,
-            *,
-            env_var: Optional[str] = None,
-            env_var_prefix: Optional[str] = None,
-            parser: Optional[Callable[[str], Any]] = None
+        self,
+        default,
+        *,
+        env_var: Optional[str] = None,
+        env_var_prefix: Optional[str] = None,
+        parser: Optional[Callable[[str], Any]] = None,
     ):
         self.default = default
         self.type = type(default)
@@ -26,7 +27,7 @@ class ConfigValue:
         self.owner = owner
         self.name = name
         if not self._env_var_prefix:
-            self._env_var_prefix = self.owner.__module__.upper().replace('.', '_')
+            self._env_var_prefix = self.owner.__module__.upper().replace(".", "_")
 
     @property
     def env_var(self):
@@ -83,11 +84,7 @@ class ConfigValue:
 class ConfigMeta(type):
     def to_dict(cls):
         """Return the config values of this class as dict."""
-        return {
-            n: v
-            for n, v in type(cls).__dict__.items()
-            if isinstance(v, ConfigValue)
-        }
+        return {n: v for n, v in type(cls).__dict__.items() if isinstance(v, ConfigValue)}
 
     def update(cls, d: dict[str, Any]):
         """
@@ -138,10 +135,7 @@ def config(env_var_prefix):
                 else:
                     # noinspection PyProtectedMember
                     meta_dict[n] = ConfigValue(
-                        default=v.default,
-                        env_var_prefix=env_var_prefix,
-                        env_var=v._env_var,
-                        parser=v.parser
+                        default=v.default, env_var_prefix=env_var_prefix, env_var=v._env_var, parser=v.parser
                     )
 
         meta = type(cls.__name__ + "Meta", (ConfigMeta,), meta_dict)
@@ -151,9 +145,15 @@ def config(env_var_prefix):
     return dec
 
 
+class PlottingBackend(Enum):
+    PLOTLY = 1
+    MATPLOTLIB = 2
+
+
 @config("PYROLL_CORE")
 class Config:
     """Configuration class for ``pyroll.core``."""
+
     ROLL_PASS_AUTO_ROTATION = True
     """Whether to enable automatic rotation of incoming profiles in roll passes by default."""
 
@@ -199,3 +199,6 @@ class Config:
 
     PLOT_RESOLUTION = 100
     """Resolution of plots in dots per inches (dpi)."""
+
+    PREFERRED_PLOTTING_BACKEND = PlottingBackend.PLOTLY
+    """Sets the preferred plotting backend to use when both matplotlib and plotly are installed."""

{pyroll_core-3.0.0.post4 → pyroll_core-3.0.1}/pyroll/core/repr.py

@@ -1,8 +1,8 @@
 import html
 from abc import ABC, abstractmethod
 from io import StringIO
-from .config import Config
-from .log import global_logger
+
+from .config import Config, PlottingBackend
 
 
 class ReprMixin(ABC):
@@ -49,11 +49,18 @@ class ReprMixin(ABC):
 
         :returns: either a plotly or matplotlib figure object
         """
-
-        try:
-            return self.plot_plotly()
-        except (NotImplementedError, ImportError):
-            return self.plot_matplotlib()
+        if Config.PREFERRED_PLOTTING_BACKEND == PlottingBackend.PLOTLY:
+            try:
+                return self.plot_plotly()
+            except (NotImplementedError, ImportError):
+                return self.plot_matplotlib()
+        elif Config.PREFERRED_PLOTTING_BACKEND == PlottingBackend.MATPLOTLIB:
+            try:
+                return self.plot_matplotlib()
+            except (NotImplementedError, ImportError):
+                return self.plot_plotly()
+
+        raise ValueError("Invalid value given for 'Config.PREFERRED_PLOTTING_BACKEND'. Value must be a member of the pyroll.core.PlottingBackend enumeration.")
 
     def __str__(self):
         return type(self).__qualname__

{pyroll_core-3.0.0.post4 → pyroll_core-3.0.1}/pyroll/core/roll/hookimpls.py

@@ -25,18 +25,27 @@ def roll_power(self: Roll):
 
 
 @Roll.working_velocity
-def working_velocity(self: Roll):
-    return self.rotational_frequency * self.working_radius * 2 * np.pi
+def working_velocity(self: Roll, cycle):
+    if not cycle:
+        return self.rotational_frequency * self.working_radius * 2 * np.pi
 
 
 @Roll.surface_velocity
-def surface_velocity(self: Roll):
-    return self.rotational_frequency * self.nominal_radius * 2 * np.pi
+def surface_velocity(self: Roll, cycle):
+    if not cycle:
+        return self.rotational_frequency * self.nominal_radius * 2 * np.pi
 
 
 @Roll.rotational_frequency
-def rotational_frequency(self: Roll):
-    return self.surface_velocity / (2 * np.pi * self.nominal_radius)
+def rotational_frequency(self: Roll, cycle):
+    if not cycle:
+        return self.surface_velocity / (2 * np.pi * self.nominal_radius)
+
+
+@Roll.rotational_frequency
+def rotational_frequency(self: Roll, cycle):
+    if not cycle:
+        return self.working_velocity / (2 * np.pi * self.working_radius)
 
 
 @Roll.width

{pyroll_core-3.0.0.post4 → pyroll_core-3.0.1}/pyroll/core/roll_pass/hookimpls/profile.py

@@ -88,6 +88,11 @@ def classifiers(self: BaseRollPass.OutProfile):
     return set(self.roll_pass.classifiers)
 
 
+@BaseRollPass.InProfile.velocity
+def in_velocity(self: BaseRollPass.InProfile):
+    return self.roll_pass.out_profile.velocity * self.unit.out_profile.cross_section.area / self.cross_section.area
+
+
 @BaseRollPass.OutProfile.velocity
-def velocity(self: BaseRollPass.OutProfile):
+def out_velocity(self: BaseRollPass.OutProfile):
     return self.roll_pass.velocity

{pyroll_core-3.0.0.post4 → pyroll_core-3.0.1}/pyroll/core/shapes.py

@@ -91,23 +91,21 @@ def multi_polygon_plot_matplotlib(self: MultiPolygon):
     ax.set_aspect("equal", "datalim")
     ax.grid(lw=0.5)
 
-    for g, c in zip(self.geoms, plt.color_sequences["default"]):
-        ax.plot(*g.boundary.xy, color=c)
-        ax.fill(*g.boundary.xy, alpha=0.5, color=c)
+    for g in self.geoms:
+        l = ax.plot(*g.boundary.xy)
+        ax.fill(*g.boundary.xy, alpha=0.5, color=l[0].get_color())
     return fig
 
 
 def multi_polygon_plot_plotly(self: MultiPolygon):
     import plotly.graph_objects as pgo
-    from pandas import DataFrame
 
     fig = pgo.Figure()
 
     for g in self.geoms:
-        fig.add_trace(pgo.line(
-            x=[g.boundary.xy[0] for g in self.geoms],
-            y=[g.boundary.xy[1] for g in self.geoms],
-            labels={"y": "y", "x": "z"},
+        fig.add_trace(pgo.Line(
+            x=np.array(g.boundary.xy[0]),
+            y=np.array(g.boundary.xy[1]),
         ))
 
     fig.update_traces(
@@ -116,9 +114,12 @@ def multi_polygon_plot_plotly(self: MultiPolygon):
 
     fig.update_yaxes(
         scaleanchor="x",
-        scaleratio=1
+        scaleratio=1,
+        title="y"
     )
 
+    fig.update_xaxes(title="z")
+
     return fig
 
 
@@ -134,7 +135,7 @@ def line_string_plot_matplotlib(self: LineString):
     ax.set_aspect("equal", "datalim")
     ax.grid(lw=0.5)
 
-    ax.plot(*self.xy, color="k")
+    ax.plot(*self.xy)
     return fig
 
 
@@ -147,8 +148,6 @@ def line_string_plot_plotly(self: LineString):
         labels={"y": "y", "x": "z"},
     )
 
-    fig.update_traces(line_color="black")
-
     fig.update_yaxes(
         scaleanchor="x",
         scaleratio=1
@@ -157,6 +156,45 @@ def line_string_plot_plotly(self: LineString):
     return fig
 
 
+def multi_line_string_plot_matplotlib(self: MultiLineString):
+    import matplotlib.pyplot as plt
+
+    fig: plt.Figure = plt.figure()
+    ax: plt.Axes = fig.subplots()
+
+    ax.set_ylabel("y")
+    ax.set_xlabel("z")
+
+    ax.set_aspect("equal", "datalim")
+    ax.grid(lw=0.5)
+
+    for g in self.geoms:
+        ax.plot(*g.xy)
+    return fig
+
+
+def multi_line_string_plot_plotly(self: MultiLineString):
+    import plotly.graph_objects as pgo
+
+    fig = pgo.Figure()
+
+    for g in self.geoms:
+        fig.add_trace(pgo.Line(
+            x=np.array(g.xy[0]),
+            y=np.array(g.xy[1]),
+        ))
+
+    fig.update_yaxes(
+        scaleanchor="x",
+        scaleratio=1,
+        title="y"
+    )
+
+    fig.update_xaxes(title="z")
+
+    return fig
+
+
 for cls in [
     LineString,
     MultiLineString,
@@ -203,6 +241,11 @@ LineString._plot_matplotlib_ = line_string_plot_matplotlib
 # noinspection PyProtectedMember
 LineString._plot_plotly_ = line_string_plot_plotly
 
+# noinspection PyProtectedMember
+MultiLineString._plot_matplotlib_ = multi_line_string_plot_matplotlib
+# noinspection PyProtectedMember
+MultiLineString._plot_plotly_ = multi_line_string_plot_plotly
+
 _RECTANGLE_CORNERS = np.asarray(
     [
         (-0.5, -0.5),