OpenRS


NameOpenRS JSON
Version 0.3.3 PyPI version JSON
download
home_pagehttps://github.com/majroy/OpenRS
SummaryOpen Residual Stress analysis suite
upload_time2023-12-18 17:48:26
maintainer
docs_urlNone
authorM J Roy
requires_python>=3.8
licenseCreative Commons Attribution-Noncommercial-Share Alike license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0) 

<span>![<span>Logo</span>](images/Logo.png)</span> 

**Open** **R**esidual **S**tress - a Python application for comparing and tabulating residual stress measurements from multiple sources, ranging from predictive finite element analyses, as well as experimental techniques.

# Functionality
This application seeks to ameliorate the current status quo for visualising residual stress fields in engineering components requiring a commercial finite element analysis package. In the same manner as computer aided design (CAD) employs interchange formats, such that component geometries can be shared between various commercial packages, there too is a need for the ability to share stress fields in these components with various stakeholders in the field of residual stress quantification.

The [Visualisation ToolKit (VTK)](http://www.vtk.org/overview/) is a powerful tool which has been leveraged for this purpose. Indeed, the free and open source FEA post processor [ParaView](https://www.paraview.org/) can be employed, and the present application makes use of VTK data structures, and extensions to navigate, interpolate and extrapolate residual stress predictions and measurements.

Primarily comprising a simplified viewer which allows a user to conduct arbitrary traces of scalar representation of stress fields in components, this repository is also populated with a series of case studies which exemplify how stresses can develop in components, and identify where further measurements need to be carried out.

# Overview
At the current stage of development, the application comprises a model viewer and the prototype of a diffraction volume viewer, existing as tabs in the main application. The main application can be launched at the command line with:

~~~
python -m OpenRS.main
~~~
This will run the OpenRS application as a script directly from the command line, with the two following sub-applications:
* [Model viewer](doc/model.md)
* [Point selector](doc/point_selector.md)

# Examples
Representative examples to be employed with the model viewer and how to generate them are available [here.](doc/examples.md)

# Installation
Python package dependencies are available through PyPI by running the following at the command line:
~~~
pip install OpenRS
~~~
If it is desired to generate finite element models, then it is recommended that either Dassault Systèmes' ABAQUS is available, with limited support for CalculiX. For more information on CalculiX, see http://www.dhondt.de/

Note that scripts for generating the examples are not included as part of the PyPI installer. These can be either copied from `OpenRS\examples` or from a cloned repository.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/majroy/OpenRS",
    "name": "OpenRS",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "",
    "author": "M J Roy",
    "author_email": "matthew.roy@manchester.ac.uk",
    "download_url": "https://files.pythonhosted.org/packages/7d/14/2224351433cf6c3f68b5a553382f12c40a1af139d2d5a452008fdc3b751f/OpenRS-0.3.3.tar.gz",
    "platform": null,
    "description": "[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0) \r\n\r\n<span>![<span>Logo</span>](images/Logo.png)</span> \r\n\r\n**Open** **R**esidual **S**tress - a Python application for comparing and tabulating residual stress measurements from multiple sources, ranging from predictive finite element analyses, as well as experimental techniques.\r\n\r\n# Functionality\r\nThis application seeks to ameliorate the current status quo for visualising residual stress fields in engineering components requiring a commercial finite element analysis package. In the same manner as computer aided design (CAD) employs interchange formats, such that component geometries can be shared between various commercial packages, there too is a need for the ability to share stress fields in these components with various stakeholders in the field of residual stress quantification.\r\n\r\nThe [Visualisation ToolKit (VTK)](http://www.vtk.org/overview/) is a powerful tool which has been leveraged for this purpose. Indeed, the free and open source FEA post processor [ParaView](https://www.paraview.org/) can be employed, and the present application makes use of VTK data structures, and extensions to navigate, interpolate and extrapolate residual stress predictions and measurements.\r\n\r\nPrimarily comprising a simplified viewer which allows a user to conduct arbitrary traces of scalar representation of stress fields in components, this repository is also populated with a series of case studies which exemplify how stresses can develop in components, and identify where further measurements need to be carried out.\r\n\r\n# Overview\r\nAt the current stage of development, the application comprises a model viewer and the prototype of a diffraction volume viewer, existing as tabs in the main application. The main application can be launched at the command line with:\r\n\r\n~~~\r\npython -m OpenRS.main\r\n~~~\r\nThis will run the OpenRS application as a script directly from the command line, with the two following sub-applications:\r\n* [Model viewer](doc/model.md)\r\n* [Point selector](doc/point_selector.md)\r\n\r\n# Examples\r\nRepresentative examples to be employed with the model viewer and how to generate them are available [here.](doc/examples.md)\r\n\r\n# Installation\r\nPython package dependencies are available through PyPI by running the following at the command line:\r\n~~~\r\npip install OpenRS\r\n~~~\r\nIf it is desired to generate finite element models, then it is recommended that either Dassault Syst\u00c3\u00a8mes' ABAQUS is available, with limited support for CalculiX. For more information on CalculiX, see http://www.dhondt.de/\r\n\r\nNote that scripts for generating the examples are not included as part of the PyPI installer. These can be either copied from `OpenRS\\examples` or from a cloned repository.\r\n",
    "bugtrack_url": null,
    "license": "Creative Commons Attribution-Noncommercial-Share Alike license",
    "summary": "Open Residual Stress analysis suite",
    "version": "0.3.3",
    "project_urls": {
        "Homepage": "https://github.com/majroy/OpenRS"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7d142224351433cf6c3f68b5a553382f12c40a1af139d2d5a452008fdc3b751f",
                "md5": "cb73f79528c69fff2a3242c211cf30e6",
                "sha256": "22adafd38bdc75a95f9b6ac59220d0ca591bdc9da1b43013a2e880d0e5d4ce4f"
            },
            "downloads": -1,
            "filename": "OpenRS-0.3.3.tar.gz",
            "has_sig": false,
            "md5_digest": "cb73f79528c69fff2a3242c211cf30e6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 4921395,
            "upload_time": "2023-12-18T17:48:26",
            "upload_time_iso_8601": "2023-12-18T17:48:26.381994Z",
            "url": "https://files.pythonhosted.org/packages/7d/14/2224351433cf6c3f68b5a553382f12c40a1af139d2d5a452008fdc3b751f/OpenRS-0.3.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-18 17:48:26",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "majroy",
    "github_project": "OpenRS",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "openrs"
}
        
Elapsed time: 0.21287s