https://github.com/pyroll-project/pyroll-mauk-gottschling-flow-stress

Plugin for PyRolL providing the flow stress approach and material database for the flow stress model of Mauk and Gottschling.
https://github.com/pyroll-project/pyroll-mauk-gottschling-flow-stress

groove-rolling materials metal-forming pyroll python rolling simulation

Last synced: 8 days ago
JSON representation

Plugin for PyRolL providing the flow stress approach and material database for the flow stress model of Mauk and Gottschling.

• Host: GitHub
• URL: https://github.com/pyroll-project/pyroll-mauk-gottschling-flow-stress
• Owner: pyroll-project
• License: bsd-3-clause
• Created: 2023-07-17T07:51:29.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-06T09:43:18.000Z (3 months ago)
• Last Synced: 2025-01-09T03:53:10.186Z (25 days ago)
• Topics: groove-rolling, materials, metal-forming, pyroll, python, rolling, simulation
• Language: Python
• Homepage: https://pyroll.readthedocs.io
• Size: 335 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PyRoll Plugin

Template for PyRoll Plugin Repositories.

Please follow the following instructions when creating your own PyRoll plugins:

- The folder `pyroll` is a namespace package, place your plugin package therein to make it discoverable by the CLI for example by just renaming the nested `plugin` package to the desired).

- Use [`pytest`](https://docs.pytest.org) for creating unit tests. Place all test files in the `tests` folder.

- Update the `pyproject.toml` with your metadata. It is recommended to use [`hatch`](https://hatch.pypa.io) to maintain dependencies, as is preconfigured. It is recommended that the plugin major version corresponds to the PyRoll Core major version (so plugin versions 2.x.x working with `pyroll-core` 2.x.x).

- Place documentation in the `docs` folder:

    - you may provide a printable documentation using LaTeX based on the `docs.tex` template and the

      provided `PyRollDocs` class

    - you may provide a web documentation using Markdown or RST rendered by GitHub or external tools

      like [Sphinx](https://www.sphinx-doc.org)

    - you may provide a printable documentation built from Markdown or RST by tools such

      as [Pandoc](https://pandoc.org/)

    - if appropriate, include the result PDF in the commit and link it from `README.md` like [so](docs/docs.pdf)

    - include model and usage information in the documentation

- Please use a permissive license such as BSD or MIT

- Edit this readme file with contents of your own needs.

    

- If you want your plugin to be listed on the main documentation website (see [here](https://pyroll.readthedocs.io/en/latest/plugins/index.html)), please contact the maintainers preferably using an issue or PR.

## Usage of the Preconfigured Hatch Scripts

To build the docs use (needs a working LaTeX installation)

    hatch run docs:build

To run the tests use

    hatch run test:all

The test environment is preconfigured to test with Python 3.9, 3.10 and 3.11.

The tests are skipped for the respective version, if it can not be found.