pyroll-core 2.0.0__tar.gz

pyroll_core-2.0.0/.gitignore

@@ -0,0 +1,430 @@
+## Python
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+## TeX
+
+## Core latex/pdflatex auxiliary files:
+*.aux
+*.lof
+*.lot
+*.fls
+*.out
+*.toc
+*.fmt
+*.fot
+*.cb
+*.cb2
+.*.lb
+
+## Intermediate documents:
+*.dvi
+*.xdv
+*-converted-to.*
+# these rules might exclude image files for figures etc.
+# *.ps
+# *.eps
+# *.pdf
+
+## Generated if empty string is given at "Please type another file name for output:"
+.pdf
+
+## Bibliography auxiliary files (bibtex/biblatex/biber):
+*.bbl
+*.bcf
+*.blg
+*-blx.aux
+*-blx.bib
+*.run.xml
+
+## Build tool auxiliary files:
+*.fdb_latexmk
+*.synctex
+*.synctex(busy)
+*.synctex.gz
+*.synctex.gz(busy)
+*.pdfsync
+
+## Build tool directories for auxiliary files
+# latexrun
+latex.out/
+
+## Auxiliary and intermediate files from other packages:
+# algorithms
+*.alg
+*.loa
+
+# achemso
+acs-*.bib
+
+# amsthm
+*.thm
+
+# beamer
+*.nav
+*.pre
+*.snm
+*.vrb
+
+# changes
+*.soc
+
+# comment
+*.cut
+
+# cprotect
+*.cpt
+
+# elsarticle (documentclass of Elsevier journals)
+*.spl
+
+# endnotes
+*.ent
+
+*.lox
+
+# feynmf/feynmp
+*.mf
+*.mp
+*.t[1-9]
+*.t[1-9][0-9]
+*.tfm
+
+#(r)(e)ledmac/(r)(e)ledpar
+*.end
+*.?end
+*.[1-9]
+*.[1-9][0-9]
+*.[1-9][0-9][0-9]
+*.[1-9]R
+*.[1-9][0-9]R
+*.[1-9][0-9][0-9]R
+*.eledsec[1-9]
+*.eledsec[1-9]R
+*.eledsec[1-9][0-9]
+*.eledsec[1-9][0-9]R
+*.eledsec[1-9][0-9][0-9]
+*.eledsec[1-9][0-9][0-9]R
+
+# glossaries
+*.acn
+*.acr
+*.glg
+*.glo
+*.gls
+*.glsdefs
+*.lzo
+*.lzs
+
+# uncomment this for glossaries-extra (will ignore makeindex's style files!)
+# *.ist
+
+# gnuplottex
+*-gnuplottex-*
+
+# gregoriotex
+*.gaux
+*.glog
+*.gtex
+
+# htlatex
+*.4ct
+*.4tc
+*.idv
+*.lg
+*.trc
+*.xref
+
+# hyperref
+*.brf
+
+# knitr
+*-concordance.tex
+# *.tikz
+*-tikzDictionary
+
+# listings
+*.lol
+
+# luatexja-ruby
+*.ltjruby
+
+# makeidx
+*.idx
+*.ilg
+*.ind
+
+# minitoc
+*.maf
+*.mlf
+*.mlt
+*.mtc[0-9]*
+*.slf[0-9]*
+*.slt[0-9]*
+*.stc[0-9]*
+
+# minted
+_minted*
+*.pyg
+
+# morewrites
+*.mw
+
+# newpax
+*.newpax
+
+# nomencl
+*.nlg
+*.nlo
+*.nls
+
+# pax
+*.pax
+
+# pdfpcnotes
+*.pdfpc
+
+# sagetex
+*.sagetex.sage
+*.sagetex.py
+*.sagetex.scmd
+
+# scrwfile
+*.wrt
+
+# sympy
+*.sout
+*.sympy
+sympy-plots-for-*.tex/
+
+# pdfcomment
+*.upa
+*.upb
+
+# pythontex
+*.pytxcode
+pythontex-files-*/
+
+# tcolorbox
+*.listing
+
+# thmtools
+*.loe
+
+# TikZ & PGF
+*.dpth
+*.md5
+*.auxlock
+
+# todonotes
+*.tdo
+
+# vhistory
+*.hst
+*.ver
+
+# easy
+*.lod
+
+# xcolor
+*.xcp
+
+# xmpincl
+*.xmpi
+
+# xindy
+*.xdy
+
+# xypic precompiled matrices and outlines
+*.xyc
+*.xyd
+
+# endfloat
+*.ttt
+*.fff
+
+# Latexian
+TSWLatexianTemp*
+
+## Editors:
+# WinEdt
+*.bak
+*.sav
+
+# Texpad
+.texpadtmp
+
+# LyX
+*.lyx~
+
+# Kile
+*.backup
+
+# gummi
+.*.swp
+
+# KBibTeX
+*~[0-9]*
+
+# TeXnicCenter
+*.tps
+
+# auto folder when using emacs and auctex
+./auto/*
+*.el
+
+# expex forward references with \gathertags
+*-tags.tex
+
+# standalone packages
+*.sta
+
+# Makeindex log files
+*.lpz
+
+# xwatermark package
+*.xwm
+
+## JetBrains
+
+.idea
+
+## HTML report
+/out/report.html

pyroll_core-2.0.0/LICENSE

@@ -0,0 +1,11 @@
+Copyright 2022 Max Weiner, Christoph Renzing, Matthias Schmidtchen, Max Stirl
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

pyroll_core-2.0.0/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.1
+Name: pyroll-core
+Version: 2.0.0
+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-Expression: BSD-3-Clause
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Hatch
+Classifier: Framework :: IPython
+Classifier: Framework :: Jupyter
+Classifier: Framework :: Pytest
+Classifier: Framework :: Sphinx
+Classifier: Intended Audience :: Manufacturing
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.8
+Requires-Dist: numpy~=1.19
+Requires-Dist: scipy~=1.9.0
+Requires-Dist: shapely~=2.0.0
+Description-Content-Type: text/markdown
+
+# PyRolL Rolling Simulation Framework
+
+[![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)
+![Downloads](https://img.shields.io/pypi/dm/pyroll-core)
+
+Welcome to The PyRolL Project!
+
+PyRolL is an OpenSource rolling framework, aimed to provide a fast and extensible base for rolling simulation.
+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).
+
+## Versions
+
+The main branch of this repository contains the code of the version 2.0 of PyRolL, which is under ongoing development and currently in beta state.
+See the [backport branch](https://github.com/pyroll-project/pyroll-core/tree/v1.0_backport) for the code of version 1.0.
+Version 1.0 will be out of support, as version 2.0 is released.
+Consider to start development targeting version 2.0 as soon as possible.
+The API of version 2.0 is mostly fixed, but there may be minor but breaking changes until release.
+
+### Principal Changes of Version 2.0 Respective to 1.0
+
+- Split of old `pyroll` package into `pyroll-core`, `pyroll-report`, `pyroll-export` and `pyroll-cli`.
+- Complete reworking of the hook system.
+    - Implementation of own hooking framework and removal of pluggy.
+    - Simpler user interface for hook definition and implementation.
+    - More orthodox default hook implementations, removal of "basic models".
+- Rework of the object model.
+    - Stricter hierarchy of unit classes.
+    - Extended possibilities of groove definition.
+    - Roll passes with three working rolls.
+    - New unit classes: `Rotator`, `PassSequence`, `ThreeRollPass`.
+    - 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).
+
+## Contributing
+
+Feel free to open issues, or, fork and open pull requests, if you want to contribute to the core.
+If you want to implement model approaches for use with PyRolL, create your own plugin package using our [plugin template](https://github.com/pyroll-project/pyroll-plugin-template).
+To learn how to write plugins and extensions, please read the [documentation](https://pyroll.readthedocs.io/en/latest) and refer to the numerous existing plugins and extensions available at the [organization's GitHub page](https://github.com/pyroll-project).
+
+### Policy for Inclusion of Hooks in the Core
+
+Since version 2.0 we try to include as many hooks as possible into the core, to tie down the nomenclature.
+This seems necessary, since for the same concepts, often different terms exist in literature.
+To avoid collisions and redundancies, it is better to include these hooks in the core, although some of them may come without implementation.
+This improves the exchangeability of plugins.
+If you like a hook to be included in the core, open an issue, or preferably, a pull request with the respective changes.
+Supply your pull request with fallback implementations of the hook, if any meaningful exist.
+
+From this policy we explicitly exclude hooks, that are solely of use for one model approach, namely "coefficients".
+They are large in number across the whole plugin landscape, but usually named after the model and of no further use to other plugins.
+So the benefit from including them in the core is small, while the pollution of the core would be exzessive.
+If another plugin has to make use of them, just add a dependency for the respective source plugin.
+
+A few examples for clarification:
+
+- The hooks `Profile.surface_temperature` and `Profile.core_temperature` may be of interests to many plugins.
+  The core provides fallbacks which just return `self.temperature`, which is a good first estimate of those.
+  So plugins modelling surface and thermal effects can easily refer to the respective temperatures, without worrying, if there is a model describing the temperature gradient or not.
+- The hook `Profile.freiberg_flow_stress_coefficients` from the `pyroll-freiberg-flow-stress` plugin makes no sense without the Freiberg flow stress model, so it is not included in the core.
+- The hook `Profile.thermal_conductivity` is a material property useful to many plugins, but no meaningful fallback exists, since there is no default material.
+  So the provision of values or implementations is deferred to the user or developers of material databases.
+
+So the core includes several hooks, that are not used by other core functionality, but provide a save ground for plugins.

pyroll_core-2.0.0/README.md

@@ -0,0 +1,77 @@
+# PyRolL Rolling Simulation Framework
+
+[![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)
+![Downloads](https://img.shields.io/pypi/dm/pyroll-core)
+
+Welcome to The PyRolL Project!
+
+PyRolL is an OpenSource rolling framework, aimed to provide a fast and extensible base for rolling simulation.
+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).
+
+## Versions
+
+The main branch of this repository contains the code of the version 2.0 of PyRolL, which is under ongoing development and currently in beta state.
+See the [backport branch](https://github.com/pyroll-project/pyroll-core/tree/v1.0_backport) for the code of version 1.0.
+Version 1.0 will be out of support, as version 2.0 is released.
+Consider to start development targeting version 2.0 as soon as possible.
+The API of version 2.0 is mostly fixed, but there may be minor but breaking changes until release.
+
+### Principal Changes of Version 2.0 Respective to 1.0
+
+- Split of old `pyroll` package into `pyroll-core`, `pyroll-report`, `pyroll-export` and `pyroll-cli`.
+- Complete reworking of the hook system.
+    - Implementation of own hooking framework and removal of pluggy.
+    - Simpler user interface for hook definition and implementation.
+    - More orthodox default hook implementations, removal of "basic models".
+- Rework of the object model.
+    - Stricter hierarchy of unit classes.
+    - Extended possibilities of groove definition.
+    - Roll passes with three working rolls.
+    - New unit classes: `Rotator`, `PassSequence`, `ThreeRollPass`.
+    - 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).
+
+## Contributing
+
+Feel free to open issues, or, fork and open pull requests, if you want to contribute to the core.
+If you want to implement model approaches for use with PyRolL, create your own plugin package using our [plugin template](https://github.com/pyroll-project/pyroll-plugin-template).
+To learn how to write plugins and extensions, please read the [documentation](https://pyroll.readthedocs.io/en/latest) and refer to the numerous existing plugins and extensions available at the [organization's GitHub page](https://github.com/pyroll-project).
+
+### Policy for Inclusion of Hooks in the Core
+
+Since version 2.0 we try to include as many hooks as possible into the core, to tie down the nomenclature.
+This seems necessary, since for the same concepts, often different terms exist in literature.
+To avoid collisions and redundancies, it is better to include these hooks in the core, although some of them may come without implementation.
+This improves the exchangeability of plugins.
+If you like a hook to be included in the core, open an issue, or preferably, a pull request with the respective changes.
+Supply your pull request with fallback implementations of the hook, if any meaningful exist.
+
+From this policy we explicitly exclude hooks, that are solely of use for one model approach, namely "coefficients".
+They are large in number across the whole plugin landscape, but usually named after the model and of no further use to other plugins.
+So the benefit from including them in the core is small, while the pollution of the core would be exzessive.
+If another plugin has to make use of them, just add a dependency for the respective source plugin.
+
+A few examples for clarification:
+
+- The hooks `Profile.surface_temperature` and `Profile.core_temperature` may be of interests to many plugins.
+  The core provides fallbacks which just return `self.temperature`, which is a good first estimate of those.
+  So plugins modelling surface and thermal effects can easily refer to the respective temperatures, without worrying, if there is a model describing the temperature gradient or not.
+- The hook `Profile.freiberg_flow_stress_coefficients` from the `pyroll-freiberg-flow-stress` plugin makes no sense without the Freiberg flow stress model, so it is not included in the core.
+- The hook `Profile.thermal_conductivity` is a material property useful to many plugins, but no meaningful fallback exists, since there is no default material.
+  So the provision of values or implementations is deferred to the user or developers of material databases.
+
+So the core includes several hooks, that are not used by other core functionality, but provide a save ground for plugins.

pyroll_core-2.0.0/hatch.toml

@@ -0,0 +1,30 @@
+[build]
+packages = [
+    "pyroll"
+]
+
+[version]
+path = "pyroll/core/__init__.py"
+
+[envs.default]
+path = ".venv"
+dependencies = [
+    "ipython ~= 8.0",
+    "pytest ~= 7.0",
+    "matplotlib ~= 3.6",
+#    "pyroll-report ~= 2.0.0",
+]
+
+[envs.test]
+path = ""
+dependencies = [
+    "pytest ~= 7.0",
+    "matplotlib ~= 3.6",
+]
+
+[[envs.test.matrix]]
+python = ["3.9", "3.10", "3.11"]
+
+[envs.test.scripts]
+all = "pytest tests"
+solve = "pytest tests/test_solve.py"

pyroll_core-2.0.0/pyproject.toml

@@ -0,0 +1,47 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pyroll-core"
+description = "PyRoll rolling simulation framework - core library."
+authors = [
+    { name = "Max Weiner", email = "max.weiner@imf.tu-freiberg.de" },
+    { name = "Christoph Renzing", email = "christoph.renzing@imf.tu-freiberg.de" },
+    { name = "Matthias Schmidtchen", email = "matthias.schmidtchen@imf.tu-freiberg.de" },
+    { name = "Max Stirl", email = "max.stirl@imf.tu-freiberg.de" },
+]
+license = "BSD-3-Clause"
+readme = "README.md"
+classifiers = [
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Manufacturing",
+    "Operating System :: OS Independent",
+    "Topic :: Scientific/Engineering",
+    "License :: OSI Approved :: BSD License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Development Status :: 5 - Production/Stable",
+    "Framework :: Hatch",
+    "Framework :: IPython",
+    "Framework :: Jupyter",
+    "Framework :: Pytest",
+    "Framework :: Sphinx",
+    "Natural Language :: English",
+]
+requires-python = ">=3.8"
+
+dependencies = [
+    "numpy ~= 1.19",
+    "scipy ~= 1.9.0",
+    "shapely ~= 2.0.0",
+]
+
+dynamic = ["version"]
+
+[project.urls]
+Homepage = "https://pyroll-project.github.io"
+Repository = "https://github.com/pyroll-project/pyroll-core"
+Documentation = "https://pyroll.readthedocs.io/en/latest"