pybearing 1.0.0__tar.gz

pybearing-1.0.0/.github/workflows/pytest.yml

@@ -0,0 +1,36 @@
+name: Pytest on push and pull requests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        os: ['ubuntu-latest', 'windows-latest']
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: 'pip'
+
+    - name: Install packages
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install ".[dev]"
+
+    - name: Run tests
+      run: |
+        pytest

pybearing-1.0.0/.github/workflows/release-and-publish-to-pypi.yml

@@ -0,0 +1,32 @@
+name: Release and Publish to PyPI
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    
+    # IMPORTANT: These permissions are required for Trusted Publishing (OIDC)
+    permissions:
+      id-token: write 
+      contents: read
+      
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: python -m pip install -U build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

pybearing-1.0.0/.gitignore

@@ -0,0 +1,210 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.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/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Skip dev folder
+dev/*

pybearing-1.0.0/License

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Ladisk 2026
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

pybearing-1.0.0/PKG-INFO

@@ -0,0 +1,43 @@
+Metadata-Version: 2.4
+Name: pybearing
+Version: 1.0.0
+Summary: Simple package to calculate bearing characteristic frequencies and perform envelope analysis.
+Author-email: "Matej Anko, Janko Slavič" <janko.slavic@fs.uni-lj.si>
+Maintainer-email: "Matej Anko, Janko Slavič" <janko.slavic@fs.uni-lj.si>
+Keywords: bearing,characteristic frequencies,envelope analysis
+Requires-Python: >=3.10
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: scipy
+Provides-Extra: dev
+Requires-Dist: pytest>=9.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+![pyBearing](images/pyBearing.png)
+
+# pyBearing
+
+A lightweight Python package for calculating bearing fault characteristic frequencies and performing envelope analysis for fault detection.
+
+## Features
+
+- Bearing fault characteristic frequencies calculation
+- Bearing database
+- Envelope extraction and visualization
+
+## Installation
+
+To install the package, run:
+
+```bash
+pip install pybearing
+```
+
+## Examples
+
+Example notebooks and scripts are available in the `examples/` directory:
+
+- Bearing and FaultFrequencies dataclass showcase
+- Use of bearing database
+- Showcase of envelope extraction and spectrum on measurement of faulty bearing

pybearing-1.0.0/README.md

@@ -0,0 +1,27 @@
+![pyBearing](images/pyBearing.png)
+
+# pyBearing
+
+A lightweight Python package for calculating bearing fault characteristic frequencies and performing envelope analysis for fault detection.
+
+## Features
+
+- Bearing fault characteristic frequencies calculation
+- Bearing database
+- Envelope extraction and visualization
+
+## Installation
+
+To install the package, run:
+
+```bash
+pip install pybearing
+```
+
+## Examples
+
+Example notebooks and scripts are available in the `examples/` directory:
+
+- Bearing and FaultFrequencies dataclass showcase
+- Use of bearing database
+- Showcase of envelope extraction and spectrum on measurement of faulty bearing

pybearing-1.0.0/examples/0_bearing_and_fault_frequencies.ipynb

@@ -0,0 +1,207 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "dd2f8734",
+   "metadata": {},
+   "source": [
+    "# Bearing\n",
+    "\n",
+    "The core component of pyBearing library is `Bearing` dataclass and holds information about the bearing name, type, manufacturer and geometry."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "4b0fab36",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from pybearing.core.bearing import Bearing"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "ca69c88c",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Bearing NMB_1560kk (Deep Groove Ball Bearing):\n",
+      "  Inner Diameter: 6 mm\n",
+      "  Outer Diameter: 15 mm\n",
+      "  Width: 5 mm\n",
+      "  Rolling element Diameter: 2.77 mm\n",
+      "  Mean Diameter: 10.514 mm\n",
+      "  Contact Angle: Not specified rad\n",
+      "  Number of Rolling Elements: 7\n",
+      "  Manufacturer: NMB\n",
+      "\n"
+     ]
+    }
+   ],
+   "source": [
+    "bearing_1 = Bearing(\n",
+    "    name=\"NMB_1560kk\",\n",
+    "    d=6, # mm\n",
+    "    D=15, # mm\n",
+    "    B=5, # mm\n",
+    "    D_b=2.77, # mm\n",
+    "    D_m=10.514, # mm\n",
+    "    theta=0, # rad\n",
+    "    N_b=7, # number of rolling elements\n",
+    "    bearing_type=\"Deep Groove Ball Bearing\",\n",
+    "    manufacturer=\"NMB\"\n",
+    ")\n",
+    "\n",
+    "print(bearing_1)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "ae308292",
+   "metadata": {},
+   "source": [
+    "# Fault Frequencies\n",
+    "\n",
+    "Another core component of pyBearing is `FaultFrequencies` dataclass and holds information about frequency of rotation and coresponding bearing fault frequencies."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "e409c505",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from pybearing.core.fault_frequencies import FaultFrequencies"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "330012fa",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Fault Frequencies at 6.0 Hz:\n",
+      "  Cage: 1.0 Hz\n",
+      "  Rolling Element About Axis: 2.0 Hz\n",
+      "  Outer Ring: 3.0 Hz\n",
+      "  Rolling Element: 4.0 Hz\n",
+      "  Inner Ring: 5.0 Hz\n"
+     ]
+    }
+   ],
+   "source": [
+    "fault_frequencies_1 = FaultFrequencies(\n",
+    "    f_cage=1.0, # Hz\n",
+    "    f_rolling_element_about_axis=2.0, # Hz\n",
+    "    f_outer_ring=3.0, # Hz\n",
+    "    f_rolling_element=4.0, # Hz\n",
+    "    f_inner_ring=5.0, # Hz\n",
+    "    f_of_rotation=6.0, # Hz\n",
+    ")\n",
+    "\n",
+    "print(fault_frequencies_1)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "56f10aba",
+   "metadata": {},
+   "source": [
+    "The `FaultFrequencies` dataclass can be multiplied by the rotational frequency to scale fault frequencies to the right value of `f_of_rotation`."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "30b2f602",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Fault Frequencies at 180.0 Hz:\n",
+      "  Cage: 30.0 Hz\n",
+      "  Rolling Element About Axis: 60.0 Hz\n",
+      "  Outer Ring: 90.0 Hz\n",
+      "  Rolling Element: 120.0 Hz\n",
+      "  Inner Ring: 150.0 Hz\n"
+     ]
+    }
+   ],
+   "source": [
+    "new_f_of_rotation = 30 # Hz\n",
+    "print(fault_frequencies_1 * new_f_of_rotation)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "5b1a7093",
+   "metadata": {},
+   "source": [
+    "`FaultFrequencies` can be calculated from the known internal geometry of the bearing, using the `get_fault_frequencies` function."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "32add70e",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Fault Frequencies at 16.6667 Hz:\n",
+      "  Cage: 6.1379 Hz\n",
+      "  Rolling Element About Axis: 29.4351 Hz\n",
+      "  Outer Ring: 42.965 Hz\n",
+      "  Rolling Element: 58.8702 Hz\n",
+      "  Inner Ring: 73.7019 Hz\n"
+     ]
+    }
+   ],
+   "source": [
+    "from pybearing.analysis.fault_frequencies_analysis import get_fault_frequencies\n",
+    "\n",
+    "fault_frequencies_2 = get_fault_frequencies(bearing_1,  # Bearing object\n",
+    "                                            1000,       # RPM\n",
+    "                                            True,       # If inner ring is rotating\n",
+    "                                            \"geometry\"  # Calculate fault frequencies from geometry\n",
+    "                                            )\n",
+    "print(fault_frequencies_2)"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "venv (3.13.5)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.13.5"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}