[](https://opensource.org/licenses/MIT)
[](https://badge.fury.io/py/paramaterial)
[//]: # ()
[//]: # ()
## About
A Python package for parameterizing materials test data. Given a set of experimental measurements, Paramaterial can be
used to determine material properties and constitutive model parameters.
* **Source Code**: [https://github.com/dan-slater/paramaterial](https://github.com/dan-slater/paramaterial)
* **Documentation**: [https://dan-slater.github.io/paramaterial/](https://dan-slater.github.io/paramaterial/)
* **PyPI**: [https://pypi.org/project/paramaterial/](https://pypi.org/project/paramaterial/)
* **Examples**: [https://github.com/dan-slater/paramaterial-examples](https://github.com/dan-slater/paramaterial-examples)
The package was designed to help improve the quality and quantity of data available for materials modeling and
simulation. It is hoped that using Paramaterial will help improve repeatability and reproducibility of materials test
data analyses, and help to reduce the time and effort required to perform such analyses.
## Installation
```shell
pip install paramaterial
```
## Usage
Please see the [API reference](reference/example.md) for details on the toolkit's
functions and classes.
Usage examples are available in the [examples repository](https://github.com/dan-slater/paramaterial-examples).
These examples can be downloaded using the `download_example` function:
```python
# Download the basic usage example to the current directory
from paramaterial import download_example
download_example('dan_msc_basic_usage_0.1.0')
# Other examples are also currently available:
# download_example('dan_msc_cs1_0.1.0')
# download_example('dan_msc_cs2_0.1.0')
# download_example('dan_msc_cs3_0.1.0')
# download_example('dan_msc_cs4_0.1.0')
```
The examples include datasets, notebooks, and other assets that showcase the functionality and capabilities of the Paramaterial library. These examples can be downloaded and run locally, providing an interactive way to explore and learn about the library.
For more details see the documentation for the `download_example` function at [reference/example](reference/example.md).
## Overview
Paramaterial is an open-source Python package for parameterising materials test
data. Paramaterial provides functionality for the repeatable processing of mechanical test results,
such as stress-strain data from a tensile test. An example of various stages of data processing that
might be performed using the toolkit is shown in the figure below.
Paramaterial is also useful for generating a table of parameters from raw data, as illustrated below. Various data analysis techniques can then be applied to this table of parameters.
## Contributing
Please go to the GitHub repository and submit an issue or pull request.
## License
Paramaterial is licensed under the MIT license.
Raw data
{
"_id": null,
"home_page": "https://github.com/dan-slater/paramaterial",
"name": "paramaterial",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,mechanical testing,materials testing,post-processing,stress-strain,flow stress,yield stress,tensile test,strength,elastic modulus,strain,universal testing machine,fitting constitutive model,material model,solid mechanics,materials science,engineering",
"author": "Daniel Slater",
"author_email": "danielgslater@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/51/83/b2ed7a2002428f0f7ff35fd31a568b8aedb7614a4a78d665cd1c76012d30/paramaterial-0.1.3.tar.gz",
"platform": null,
"description": "\r\n\r\n[](https://opensource.org/licenses/MIT)\r\n\r\n\r\n[](https://badge.fury.io/py/paramaterial)\r\n\r\n\r\n[//]: # ()\r\n[//]: # ()\r\n\r\n## About\r\n\r\nA Python package for parameterizing materials test data. Given a set of experimental measurements, Paramaterial can be\r\nused to determine material properties and constitutive model parameters.\r\n\r\n* **Source Code**: [https://github.com/dan-slater/paramaterial](https://github.com/dan-slater/paramaterial)\r\n\r\n* **Documentation**: [https://dan-slater.github.io/paramaterial/](https://dan-slater.github.io/paramaterial/)\r\n\r\n* **PyPI**: [https://pypi.org/project/paramaterial/](https://pypi.org/project/paramaterial/)\r\n\r\n* **Examples**: [https://github.com/dan-slater/paramaterial-examples](https://github.com/dan-slater/paramaterial-examples)\r\n\r\nThe package was designed to help improve the quality and quantity of data available for materials modeling and\r\nsimulation. It is hoped that using Paramaterial will help improve repeatability and reproducibility of materials test\r\ndata analyses, and help to reduce the time and effort required to perform such analyses.\r\n\r\n\r\n## Installation\r\n\r\n```shell\r\npip install paramaterial\r\n```\r\n\r\n## Usage\r\n\r\nPlease see the [API reference](reference/example.md) for details on the toolkit's\r\nfunctions and classes.\r\n\r\nUsage examples are available in the [examples repository](https://github.com/dan-slater/paramaterial-examples).\r\nThese examples can be downloaded using the `download_example` function:\r\n\r\n```python\r\n# Download the basic usage example to the current directory\r\nfrom paramaterial import download_example\r\ndownload_example('dan_msc_basic_usage_0.1.0')\r\n# Other examples are also currently available:\r\n# download_example('dan_msc_cs1_0.1.0')\r\n# download_example('dan_msc_cs2_0.1.0')\r\n# download_example('dan_msc_cs3_0.1.0')\r\n# download_example('dan_msc_cs4_0.1.0')\r\n```\r\n\r\nThe examples include datasets, notebooks, and other assets that showcase the functionality and capabilities of the Paramaterial library. These examples can be downloaded and run locally, providing an interactive way to explore and learn about the library.\r\nFor more details see the documentation for the `download_example` function at [reference/example](reference/example.md).\r\n## Overview\r\n\r\nParamaterial is an open-source Python package for parameterising materials test\r\ndata. Paramaterial provides functionality for the repeatable processing of mechanical test results,\r\nsuch as stress-strain data from a tensile test. An example of various stages of data processing that\r\nmight be performed using the toolkit is shown in the figure below.\r\n\r\n\r\n\r\nParamaterial is also useful for generating a table of parameters from raw data, as illustrated below. Various data analysis techniques can then be applied to this table of parameters.\r\n\r\n\r\n\r\n## Contributing\r\n\r\nPlease go to the GitHub repository and submit an issue or pull request.\r\n\r\n## License\r\n\r\nParamaterial is licensed under the MIT license. \r\n\r\n\r\n",
"bugtrack_url": null,
"license": "",
"summary": "Software toolkit for parameterising materials test data. Easily batch process experimental measurements to determine mechanical properties and material model parameters.",
"version": "0.1.3",
"project_urls": {
"Homepage": "https://github.com/dan-slater/paramaterial"
},
"split_keywords": [
"python",
"mechanical testing",
"materials testing",
"post-processing",
"stress-strain",
"flow stress",
"yield stress",
"tensile test",
"strength",
"elastic modulus",
"strain",
"universal testing machine",
"fitting constitutive model",
"material model",
"solid mechanics",
"materials science",
"engineering"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "859b138394c256fb29550a4339e39de81d241c81d252f756ec5e269ebd7911b5",
"md5": "89ce7efca9641b545426cdae8e22608b",
"sha256": "f62415c81f124b0adf2cb0af45a102939923202ceedfe4a0d2be64c790b06e18"
},
"downloads": -1,
"filename": "paramaterial-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "89ce7efca9641b545426cdae8e22608b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 37432,
"upload_time": "2023-09-02T12:56:35",
"upload_time_iso_8601": "2023-09-02T12:56:35.910024Z",
"url": "https://files.pythonhosted.org/packages/85/9b/138394c256fb29550a4339e39de81d241c81d252f756ec5e269ebd7911b5/paramaterial-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5183b2ed7a2002428f0f7ff35fd31a568b8aedb7614a4a78d665cd1c76012d30",
"md5": "04b7340cef9852b9dfcad1e96f878a26",
"sha256": "308265a99c9adf251bc7affd5a3c9ab1d60b88cb8bc5e3e600ccf604cffa7065"
},
"downloads": -1,
"filename": "paramaterial-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "04b7340cef9852b9dfcad1e96f878a26",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 36482,
"upload_time": "2023-09-02T12:56:37",
"upload_time_iso_8601": "2023-09-02T12:56:37.936722Z",
"url": "https://files.pythonhosted.org/packages/51/83/b2ed7a2002428f0f7ff35fd31a568b8aedb7614a4a78d665cd1c76012d30/paramaterial-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-02 12:56:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dan-slater",
"github_project": "paramaterial",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "paramaterial"
}
JSON
