# Backlash Model with Linear Decision Boundaries (blm)
[![License](https://img.shields.io/badge/license-MIT-brightgreen)](https://opensource.org/licenses/MIT)
[![codecov](https://codecov.io/gh/famura/blm/branch/master/graph/badge.svg?token=ESUTNFwtYY)](https://codecov.io/gh/famura/blm)
[![codestyle](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
A simple model to describe the backlash effect in physics simulations based on numpy
The model implemented in this package was published as:
J. Vörös, "Modeling and identification of systems with backlash", Automatica, 2008, [link to pdf](https://www.researchgate.net/profile/Jozef-Voeroes/publication/233692268_Identification_of_cascade_systems_with_backlash/links/56b3535f08ae3d06a266451d/Identification-of-cascade-systems-with-backlash.pdf)
## Support
If you use code or ideas from this repository for your projects or research, **please cite it**.
```
@misc{Muratore_blm,
author = {Fabio Muratore},
title = {blm - A simple model to describe the backlash effect in physics simulations},
year = {2021},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/famura/blm}}
}
```
## Installation
To install the core part of the package run
```
pip install blm
```
For (local) development install the dependencies with
```
pip install -e .[dev]
```
## Getting Started
Play around with the model's parameters in the `demo.py` scirpt
```
cd examples
python demo.py
```
![demo](assets/demo.png?raw=true "output of demo.py")
Raw data
{
"_id": null,
"home_page": "https://github.com/famura/blm",
"name": "blm",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7, <4",
"maintainer_email": "",
"keywords": "backlash,simulation,physics,modeling",
"author": "Fabio Muratore",
"author_email": "fabio.muratore@famura.net",
"download_url": "https://files.pythonhosted.org/packages/90/d5/3d220f20221ca755f852cd78b841ed8e77591c13870872d496b3de2a3ee0/blm-1.1.tar.gz",
"platform": null,
"description": "# Backlash Model with Linear Decision Boundaries (blm)\n\n[![License](https://img.shields.io/badge/license-MIT-brightgreen)](https://opensource.org/licenses/MIT)\n[![codecov](https://codecov.io/gh/famura/blm/branch/master/graph/badge.svg?token=ESUTNFwtYY)](https://codecov.io/gh/famura/blm)\n[![codestyle](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\nA simple model to describe the backlash effect in physics simulations based on numpy\n\nThe model implemented in this package was published as: \nJ. V\u00f6r\u00f6s, \"Modeling and identification of systems with backlash\", Automatica, 2008, [link to pdf](https://www.researchgate.net/profile/Jozef-Voeroes/publication/233692268_Identification_of_cascade_systems_with_backlash/links/56b3535f08ae3d06a266451d/Identification-of-cascade-systems-with-backlash.pdf)\n\n## Support\n\nIf you use code or ideas from this repository for your projects or research, **please cite it**.\n```\n@misc{Muratore_blm,\n author = {Fabio Muratore},\n title = {blm - A simple model to describe the backlash effect in physics simulations},\n year = {2021},\n publisher = {GitHub},\n journal = {GitHub repository},\n howpublished = {\\url{https://github.com/famura/blm}}\n}\n```\n\n## Installation\n\nTo install the core part of the package run\n```\npip install blm\n```\n\nFor (local) development install the dependencies with\n```\npip install -e .[dev]\n```\n\n## Getting Started\n\nPlay around with the model's parameters in the `demo.py` scirpt\n```\ncd examples\npython demo.py\n```\n\n![demo](assets/demo.png?raw=true \"output of demo.py\")\n",
"bugtrack_url": null,
"license": "",
"summary": "A simple model to describe the backlash effect in physics simulations",
"version": "1.1",
"project_urls": {
"Bug Reports": "https://github.com/famura/blm/issues",
"Homepage": "https://github.com/famura/blm",
"Source": "https://github.com/famura/blm"
},
"split_keywords": [
"backlash",
"simulation",
"physics",
"modeling"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "495613c57e5fcc1eb4228b8d0f6a04baa7fa1e6108387bae71f3f68c16114266",
"md5": "144f542bec6a9f6033d6439fec52c87f",
"sha256": "16052be4f3d937af74074f9e00dd10ec77dafa56269317b0dbb602366e3cb5de"
},
"downloads": -1,
"filename": "blm-1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "144f542bec6a9f6033d6439fec52c87f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7, <4",
"size": 5248,
"upload_time": "2023-11-11T15:29:30",
"upload_time_iso_8601": "2023-11-11T15:29:30.551801Z",
"url": "https://files.pythonhosted.org/packages/49/56/13c57e5fcc1eb4228b8d0f6a04baa7fa1e6108387bae71f3f68c16114266/blm-1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "90d53d220f20221ca755f852cd78b841ed8e77591c13870872d496b3de2a3ee0",
"md5": "239c1b3314918e9d3b9d0b284a38ce79",
"sha256": "e15bb46c5d9d5b1e87ed380c051b393db3bbd84f0ffa0614a0359a7a82542bc6"
},
"downloads": -1,
"filename": "blm-1.1.tar.gz",
"has_sig": false,
"md5_digest": "239c1b3314918e9d3b9d0b284a38ce79",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7, <4",
"size": 6921,
"upload_time": "2023-11-11T15:29:31",
"upload_time_iso_8601": "2023-11-11T15:29:31.791083Z",
"url": "https://files.pythonhosted.org/packages/90/d5/3d220f20221ca755f852cd78b841ed8e77591c13870872d496b3de2a3ee0/blm-1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-11 15:29:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "famura",
"github_project": "blm",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "blm"
}