pyroll-core 2.1.2.post0__tar.gz → 2.1.4__tar.gz

{pyroll_core-2.1.2.post0 → pyroll_core-2.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyroll-core
-Version: 2.1.2.post0
+Version: 2.1.4
 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
@@ -25,11 +25,18 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Scientific/Engineering
 Requires-Python: >=3.9
+Requires-Dist: ezdxf
 Requires-Dist: numpy~=1.19
 Requires-Dist: scipy~=1.9
 Requires-Dist: shapely~=2.0
+Provides-Extra: matplotlib
+Requires-Dist: matplotlib~=3.7; extra == 'matplotlib'
 Provides-Extra: plot
 Requires-Dist: matplotlib~=3.7; extra == 'plot'
+Provides-Extra: plotly
+Requires-Dist: kaleido; extra == 'plotly'
+Requires-Dist: pandas~=2.0; extra == 'plotly'
+Requires-Dist: plotly~=5.18; extra == 'plotly'
 Description-Content-Type: text/markdown
 
 # PyRolL Rolling Simulation Framework
@@ -37,7 +44,10 @@ Description-Content-Type: text/markdown
 [![PyPI](https://img.shields.io/pypi/v/pyroll-core)](https://pypi.org/project/pyroll-core/)
 ![Python Versions](https://img.shields.io/pypi/pyversions/pyroll-core)
 [![License](https://img.shields.io/pypi/l/pyroll-core)](LICENSE)
+[![DOI](https://joss.theoj.org/papers/10.21105/joss.06200/status.svg)](https://doi.org/10.21105/joss.06200)
 ![Downloads](https://img.shields.io/pypi/dm/pyroll-core)
+[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/7971/badge)](https://www.bestpractices.dev/projects/7971)
+
 
 Welcome to The PyRolL Project!
 
@@ -46,6 +56,25 @@ The current focus lies on groove rolling in elongation grooves.
 The core package includes the basic data structures and algorithms.
 Further functionality is provided via [extension packages](https://pyroll.readthedocs.io/en/latest/extensions/index.html) and model approaches are provided via [plugin packages](https://pyroll.readthedocs.io/en/latest/plugins/index.html).
 
+## Aim and Scope
+
+Publications in the field of groove rolling simulation are, to the authors knowledge, characterized by lack of reproducibility, mainly because often details are missing regarding implementation or numerical solution procedure or the provided equations are erroneous.
+Very few authors provide their source code alongside their publications.
+PyRolL aims to change this by providing an open basis for model and methodology development.
+The PyRolL Core package hosted in this repository is the common base dependency to refer to.
+Plugins to the core provide model approaches for the partial problems to be described in a rolling simulation, which include mechanical, thermal, material behavior and more.
+The library of available models is constantly growing and can be extended by everyone.
+Extensions provide application logic and numerical procedures helping to analyse the subject rolling process regarding its technical feasibility, optimization potential, identity error sources, or, to design a new process.
+PyRolL is therefore a tool for model developers, either with broad focus or specialists, wishing to try out for example a new physical material model within a real process simulation, as well as for technologists wishing to investigate a concrete process.
+Currently, there is no click'n'run graphical user interface (GUI) provided, at least basic knowledge of programming in general and Python in particular is needed to use the software.
+Nevertheless, this is also recommended to leverage the full power of PyRolL.
+
+## Documentation
+
+See the [documentation](https://pyroll.readthedocs.io/en/latest) to learn about basic concepts and
+usage.
+The documentation of version 1.0 can be found [here](https://pyroll.readthedocs.io/en/stable).
+
 ## Versions
 
 The main branch of this repository contains the code of the version 2.0 of PyRolL.
@@ -68,12 +97,6 @@ It is recommended to develop new plugins and extensions only for 2.0.
     - Introduction of disk elements for incremental modelling in rolling direction.
     - Nestable units (esp. pass sequences and disk elements).
 
-## Documentation
-
-See the [documentation](https://pyroll.readthedocs.io/en/latest) to learn about basic concepts and
-usage.
-The documentation of version 1.0 can be found [here](https://pyroll.readthedocs.io/en/stable).
-
 ## License
 
 The project is licensed under the [BSD 3-Clause license](LICENSE).

{pyroll_core-2.1.2.post0 → pyroll_core-2.1.4}/README.md

@@ -3,7 +3,10 @@
 [![PyPI](https://img.shields.io/pypi/v/pyroll-core)](https://pypi.org/project/pyroll-core/)
 ![Python Versions](https://img.shields.io/pypi/pyversions/pyroll-core)
 [![License](https://img.shields.io/pypi/l/pyroll-core)](LICENSE)
+[![DOI](https://joss.theoj.org/papers/10.21105/joss.06200/status.svg)](https://doi.org/10.21105/joss.06200)
 ![Downloads](https://img.shields.io/pypi/dm/pyroll-core)
+[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/7971/badge)](https://www.bestpractices.dev/projects/7971)
+
 
 Welcome to The PyRolL Project!
 
@@ -12,6 +15,25 @@ The current focus lies on groove rolling in elongation grooves.
 The core package includes the basic data structures and algorithms.
 Further functionality is provided via [extension packages](https://pyroll.readthedocs.io/en/latest/extensions/index.html) and model approaches are provided via [plugin packages](https://pyroll.readthedocs.io/en/latest/plugins/index.html).
 
+## Aim and Scope
+
+Publications in the field of groove rolling simulation are, to the authors knowledge, characterized by lack of reproducibility, mainly because often details are missing regarding implementation or numerical solution procedure or the provided equations are erroneous.
+Very few authors provide their source code alongside their publications.
+PyRolL aims to change this by providing an open basis for model and methodology development.
+The PyRolL Core package hosted in this repository is the common base dependency to refer to.
+Plugins to the core provide model approaches for the partial problems to be described in a rolling simulation, which include mechanical, thermal, material behavior and more.
+The library of available models is constantly growing and can be extended by everyone.
+Extensions provide application logic and numerical procedures helping to analyse the subject rolling process regarding its technical feasibility, optimization potential, identity error sources, or, to design a new process.
+PyRolL is therefore a tool for model developers, either with broad focus or specialists, wishing to try out for example a new physical material model within a real process simulation, as well as for technologists wishing to investigate a concrete process.
+Currently, there is no click'n'run graphical user interface (GUI) provided, at least basic knowledge of programming in general and Python in particular is needed to use the software.
+Nevertheless, this is also recommended to leverage the full power of PyRolL.
+
+## Documentation
+
+See the [documentation](https://pyroll.readthedocs.io/en/latest) to learn about basic concepts and
+usage.
+The documentation of version 1.0 can be found [here](https://pyroll.readthedocs.io/en/stable).
+
 ## Versions
 
 The main branch of this repository contains the code of the version 2.0 of PyRolL.
@@ -34,12 +56,6 @@ It is recommended to develop new plugins and extensions only for 2.0.
     - Introduction of disk elements for incremental modelling in rolling direction.
     - Nestable units (esp. pass sequences and disk elements).
 
-## Documentation
-
-See the [documentation](https://pyroll.readthedocs.io/en/latest) to learn about basic concepts and
-usage.
-The documentation of version 1.0 can be found [here](https://pyroll.readthedocs.io/en/stable).
-
 ## License
 
 The project is licensed under the [BSD 3-Clause license](LICENSE).

{pyroll_core-2.1.2.post0 → pyroll_core-2.1.4}/hatch.toml

@@ -11,20 +11,19 @@ path = ".venv"
 dependencies = [
     "ipython ~= 8.0",
     "pytest ~= 7.0",
-    "matplotlib ~= 3.6",
     "pyroll-report ~= 2.0.0",
-    "jupyter"
+    "jupyter",
 ]
+features = ["plotly", "matplotlib"]
 
 [envs.test]
 path = ""
 dependencies = [
     "pytest ~= 7.0",
-    "matplotlib ~= 3.6",
 ]
 
 [[envs.test.matrix]]
-python = ["3.9", "3.10", "3.11"]
+features = ["matplotlib", "plotly"]
 
 [envs.test.scripts]
 all = "pytest tests"

{pyroll_core-2.1.2.post0 → pyroll_core-2.1.4}/pyproject.toml

@@ -37,6 +37,7 @@ dependencies = [
     "numpy ~= 1.19",
     "scipy ~= 1.9",
     "shapely ~= 2.0",
+    "ezdxf"
 ]
 
 dynamic = ["version"]
@@ -45,6 +46,14 @@ dynamic = ["version"]
 plot = [
     "matplotlib ~= 3.7"
 ]
+matplotlib = [
+    "matplotlib ~= 3.7"
+]
+plotly = [
+    "plotly ~= 5.18",
+    "pandas ~= 2.0",
+    "kaleido"
+]
 
 [project.urls]
 Homepage = "https://pyroll-project.github.io"

{pyroll_core-2.1.2.post0 → pyroll_core-2.1.4}/pyroll/core/__init__.py

@@ -1,7 +1,7 @@
 from . import shapes as _
 
 from .grooves import *
-from .transport import Transport
+from .transport import Transport, CoolingPipe
 from .roll_pass import RollPass, DeformationUnit, ThreeRollPass
 from .unit import Unit
 from .roll import Roll
@@ -12,23 +12,36 @@ from .hooks import Hook, HookHost, HookFunction, root_hooks
 from .disk_elements import DiskElementUnit
 from .config import Config, config
 
-VERSION = "2.1.2.post0"
+VERSION = "2.1.4"
 
-root_hooks.update(
-    {
+root_hooks.extend(
+    [
         RollPass.roll_force,
         RollPass.Roll.roll_torque,
         RollPass.elongation_efficiency,
-        RollPass.OutProfile.filling_ratio,
-        RollPass.OutProfile.cross_section_filling_ratio,
-        RollPass.OutProfile.filling_error,
-        RollPass.OutProfile.cross_section_error,
+        Unit.power,
         Unit.OutProfile.cross_section,
+        Unit.OutProfile.classifiers,
         Unit.OutProfile.strain,
         Unit.OutProfile.length,
-        Unit.OutProfile.classifiers,
         Unit.OutProfile.t,
+        RollPass.OutProfile.filling_ratio,
+        RollPass.OutProfile.cross_section_filling_ratio,
+        RollPass.OutProfile.filling_error,
+        RollPass.OutProfile.cross_section_error,
         PassSequence.log_elongation,
-        Unit.power,
-    }
+    ]
 )
+
+# determine available plotting backend, plotly is preferred
+try:
+    import plotly as _
+    PLOTTING_BACKEND = "plotly"
+
+except ImportError:
+    try:
+        import matplotlib as _
+        PLOTTING_BACKEND = "matplotlib"
+
+    except ImportError:
+        PLOTTING_BACKEND = None

{pyroll_core-2.1.2.post0 → pyroll_core-2.1.4}/pyroll/core/config.py

@@ -168,3 +168,25 @@ class Config:
 
     ROLL_SURFACE_DISCRETIZATION_COUNT = 100
     """Count of discrete points used to describe the roll surface."""
+
+    UNIVERSAL_GAS_CONSTANT = 8.31446261815324
+    """Universal gas constant R."""
+
+    BOLTZMANN_CONSTANT = 1.380649e-23
+    """Boltzmann constant kB."""
+    
+    STEFAN_BOLTZMANN_CONSTANT = 5.670374419e-8
+    """Stefan-Boltzmann radiation constant σ."""
+
+    AVOGADRO_CONSTANT = 6.02214076e23
+    """Avogadro constant NA."""
+
+    STANDARD_GRAVITY = 9.80665
+    """Standard acceleration of gravity g0."""
+
+    PROFILE_CONTOUR_REFINEMENT = 0
+    """Refine the line string of profile contours with more intermediate points. 
+    Higher integers mean finer. Values < 1 disable this feature."""
+
+    GROOVE_RADIUS_POINT_COUNT = 20
+    """Count of points used to represent the radii in a generic elongation groove as line string."""

{pyroll_core-2.1.2.post0 → pyroll_core-2.1.4}/pyroll/core/grooves/base.py

@@ -65,22 +65,44 @@ class GrooveBase(ReprMixin):
         }
 
     def plot(self, **kwargs):
-        try:
-            import matplotlib.pyplot as plt
-        except ImportError as e:
+        from pyroll.core import PLOTTING_BACKEND
+        if PLOTTING_BACKEND is None:
             raise RuntimeError(
-                "This method is only available if matplotlib is installed in the environment. "
-                "You may install it using the 'plot' extra of pyroll-core."
-            ) from e
+                "This method is only available if matplotlib or plotly is installed in the environment. "
+                "You may install one of them using the 'plot', 'matplotlib' or 'plotly' extras of pyroll-core."
+            )
+
+        if PLOTTING_BACKEND == "matplotlib":
+            import matplotlib.pyplot as plt
+
+            fig: plt.Figure = plt.figure(**kwargs)
+            ax: plt.Axes = fig.subplots()
+
+            ax.set_ylabel("y")
+            ax.set_xlabel("z")
+
+            ax.set_aspect("equal", "datalim")
+            ax.grid(lw=0.5)
+
+            ax.plot(*self.contour_line.xy, color="k")
+            return fig
+
+        if PLOTTING_BACKEND == "plotly":
+            import plotly.express as px
+
+            fig = px.line(
+                x=self.contour_line.xy[0],
+                y=self.contour_line.xy[1],
+                labels={"y": "y", "x": "z"},
+                template="simple_white",
+            )
 
-        fig: plt.Figure = plt.figure(**kwargs)
-        ax: plt.Axes = fig.subplots()
+            fig.update_traces(line_color="black")
 
-        ax.set_ylabel("y")
-        ax.set_xlabel("z")
+            fig.update_yaxes(
+                scaleanchor="x",
+                scaleratio=1
+            )
 
-        ax.set_aspect("equal", "datalim")
-        ax.grid(lw=0.5)
+            return fig
 
-        ax.plot(*self.contour_line.xy, color="k")
-        return fig

{pyroll_core-2.1.2.post0 → pyroll_core-2.1.4}/pyroll/core/grooves/equivalent_ripped_groove.py

@@ -20,6 +20,7 @@ class EquivalentRibbedGroove(GenericElongationGroove):
             nominal_outer_diameter: float,
             usable_width: float,
             depth: float,
+            rib_flank_angle: Optional[float] = None,
 
             pad_angle: float = 0,
             **kwargs
@@ -42,6 +43,13 @@ class EquivalentRibbedGroove(GenericElongationGroove):
         :param kwargs: more keyword arguments passed to the GenericElongationGroove constructor
         """
 
+        self.nominal_outer_diameter = nominal_outer_diameter
+        self.base_body_height = base_body_height
+        self.rib_distance = rib_distance
+        self.rib_width = rib_width
+        self.rib_flank_angle = rib_flank_angle
+
+
         pad_angle = np.deg2rad(pad_angle)
         rib_angle = np.deg2rad(rib_angle)
 

{pyroll_core-2.1.2.post0 → pyroll_core-2.1.4}/pyroll/core/grooves/generic_elongation.py

@@ -193,22 +193,22 @@ class GenericElongationGroove(GrooveBase, ReprMixin):
         yield self.z0, self.y0
 
         if not np.isclose(self.z1, self.z3):
-            for z in np.linspace(self.z1, self.z3, 20, endpoint=False):
+            for z in np.linspace(self.z1, self.z3, Config.GROOVE_RADIUS_POINT_COUNT, endpoint=False):
                 yield z, self._r1_contour_line(z)
 
         if not np.isclose(self.z3, self.z4):
             yield self.z3, self.y3
 
         if not np.isclose(self.z4, self.z5):
-            for z in np.linspace(self.z4, self.z5, 20, endpoint=False):
+            for z in np.linspace(self.z4, self.z5, Config.GROOVE_RADIUS_POINT_COUNT, endpoint=False):
                 yield z, self._r2_contour_line(z)
 
         if not np.isclose(self.z5, self.z6):
-            for z in np.linspace(self.z5, self.z6, 20, endpoint=False):
+            for z in np.linspace(self.z5, self.z6, Config.GROOVE_RADIUS_POINT_COUNT, endpoint=False):
                 yield z, self._r3_contour_line(z)
 
         if not np.isclose(self.z6, self.z7):
-            for z in np.linspace(self.z6, self.z7, 20, endpoint=False):
+            for z in np.linspace(self.z6, self.z7, Config.GROOVE_RADIUS_POINT_COUNT, endpoint=False):
                 yield z, self._r4_contour_line(z)
 
         yield self.z9, self.y9

{pyroll_core-2.1.2.post0 → pyroll_core-2.1.4}/pyroll/core/grooves/spline.py

@@ -1,8 +1,9 @@
-from typing import Union, Tuple, Iterable, Optional
-
 import numpy as np
 import scipy.interpolate
+from pathlib import Path
+from ezdxf import readfile
 from shapely.geometry import Polygon, LineString
+from typing import Union, Tuple, Iterable, Optional
 
 from pyroll.core.grooves import GrooveBase
 
@@ -18,7 +19,7 @@ class SplineGroove(GrooveBase):
     ):
         """
         :param contour_points: an iterable of contour points to be used for the spline
-        :param classifiers: an interable of string keys used as type classifiers
+        :param classifiers: an iterable of string keys used as type classifiers
         :param usable_width: the usable width to assume for this instance, if None, the maximum width will be used
         """
         contour_points = np.asarray(contour_points, dtype="float64")
@@ -90,3 +91,48 @@ class SplineGroove(GrooveBase):
 
     def local_depth(self, z) -> Union[float, np.ndarray]:
         return self._local_depth(z)
+
+    @classmethod
+    def from_dxf_drawing(cls, filepath: Path, classifiers: Iterable[str], usable_width: Optional[float] = None,
+                         arc_discretization: int = 1000) -> 'SplineGroove':
+        """
+        Creates a spline groove with a given contour line as defined inside the .dxf drawing.
+
+        :param filepath: the filepath to the drawing
+        :param classifiers: an iterable of string keys used as type classifiers
+        :param usable_width: the usable width to assume for this instance, if None, the maximum width will be used
+        :param arc_discretization: discretization of arcs of the dxf drawing, default is 1000.
+        """
+
+        doc = readfile(filepath)
+        msp = doc.modelspace()
+
+        points = []
+        for entity in msp:
+            if entity.dxftype() == 'LINE':
+                points.append((entity.dxf.start[0], entity.dxf.start[1]))
+                points.append((entity.dxf.end[0], entity.dxf.end[1]))
+
+            elif entity.dxftype() == 'ARC':
+                center = (entity.dxf.center[0], entity.dxf.center[1])
+                radius = entity.dxf.radius
+                start_angle = np.radians(entity.dxf.start_angle)
+                end_angle = np.radians(entity.dxf.end_angle)
+
+                arc_points = [
+                    (
+                        center[0] + radius * np.cos(start_angle + (end_angle - start_angle) * i / arc_discretization),
+                        center[1] + radius * np.sin(start_angle + (end_angle - start_angle) * i / arc_discretization),
+                    )
+                    for i in range(arc_discretization + 1)
+                ]
+                points.extend(arc_points)
+
+        points.sort(key=lambda p: p[0])
+
+        distance_to_y_0 = -points[0][1]
+
+        shifted_points = [(x, y + distance_to_y_0) for x, y in points]
+        shifted_points.sort(key=lambda p: p[0])
+
+        return SplineGroove(contour_points=shifted_points, classifiers=classifiers, usable_width=usable_width)

{pyroll_core-2.1.2.post0 → pyroll_core-2.1.4}/pyroll/core/hooks.py

@@ -491,9 +491,26 @@ class HookHost(ReprMixin, LogMixin, metaclass=_HookHostMeta):
         return result
 
 
-root_hooks = set()  # filled in __init__.py due to circular imports
+class _RootHooksList(list):
+    def add(self, item):
+        self.append(item)
+
+    def insert_before(self, position, item):
+        i = self.index(position)
+        self.insert(i, item)
+
+    def insert_after(self, position, item):
+        i = self.index(position) + 1
+        self.insert(i, item)
+
+    def remove_last(self, item):
+        i = list(reversed(self)).index(item)
+        del self[-1 - i]
+
+
+root_hooks = _RootHooksList()  # filled in __init__.py due to circular imports
 """
-Set of hooks to call explicitly in each solution iteration.
+List of hooks to call explicitly in each solution iteration.
 Their values will be treated as explicitly set but reevaluated in every iteration.
 They will not be deleted during cache clearing.
 They serve as root for the calling tree and persistent iterational variables.

{pyroll_core-2.1.2.post0 → pyroll_core-2.1.4}/pyroll/core/profile/hookimpls.py

@@ -38,6 +38,11 @@ def equivalent_width(self: Profile):
     return np.sqrt(self.cross_section.area * self.width / self.height)
 
 
+@Profile.equivalent_radius
+def equivalent_radius(self: Profile):
+    return np.sqrt(self.cross_section.area / np.pi)
+
+
 @Profile.equivalent_rectangle
 def equivalent_rectangle(self: Profile):
     return rectangle(self.equivalent_width, self.equivalent_height)
@@ -55,11 +60,11 @@ def core_temperature(self: Profile):
 
 @Profile.heat_penetration_number
 def heat_penetration_number(self: Profile):
-    if hasattr(self, "thermal_conductivity") and hasattr(self, "density") and hasattr(self, "thermal_capacity"):
-        return np.sqrt(self.thermal_conductivity * self.density * self.thermal_capacity)
+    if hasattr(self, "thermal_conductivity") and hasattr(self, "density") and hasattr(self, "specific_heat_capacity"):
+        return np.sqrt(self.thermal_conductivity * self.density * self.specific_heat_capacity)
 
 
 @Profile.thermal_diffusivity
 def thermal_diffusivity(self: Profile):
-    if hasattr(self, "thermal_conductivity") and hasattr(self, "density") and hasattr(self, "thermal_capacity"):
-        return self.thermal_conductivity / (self.density * self.thermal_capacity)
+    if hasattr(self, "thermal_conductivity") and hasattr(self, "density") and hasattr(self, "specific_heat_capacity"):
+        return self.thermal_conductivity / (self.density * self.specific_heat_capacity)