uncertainty-tools 0.0.1__tar.gz

uncertainty_tools-0.0.1/.gitignore

@@ -0,0 +1,6 @@
+venv/
+.venv/
+unc_tools.egg-info/
+.pytest_cache/
+build/
+.ipynb_checkpoints/

uncertainty_tools-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Savateykin Yaroslav
+
+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.

uncertainty_tools-0.0.1/PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.4
+Name: uncertainty_tools
+Version: 0.0.1
+Summary: Utilities for uncertainty-aware regression and symbolic function helpers.
+Author-email: Savateykin Yaroslav <yaroslavsavateikinwork@yandex.ru>
+License: MIT License
+        
+        Copyright (c) 2025 Savateykin Yaroslav
+        
+        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.
+License-File: LICENSE
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: matplotlib>=3.7
+Requires-Dist: numpy>=1.23
+Requires-Dist: pandas>=1.5
+Requires-Dist: scipy>=1.10
+Requires-Dist: sympy>=1.11
+Requires-Dist: uncertainties>=3.1
+Provides-Extra: test
+Requires-Dist: pytest>=7.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# unc_tools
+
+Utilities for uncertainty-aware regression and symbolic function helpers.
+
+Python version: 3.10+
+
+## Install (uv)
+
+```bash
+uv venv
+uv pip install -e .
+```
+
+## Install (pip)
+
+```bash
+pip install unc_tools
+```
+
+## Usage
+
+```python
+from unc_tools import FunctionBase1D, Poly, UncRegression
+
+# Symbolic expression with coefficients.
+expr = FunctionBase1D("a*x + b")
+
+# Polynomial helper.
+poly = Poly(2)
+
+# Regression with uncertainty propagation.
+reg = UncRegression([0, 1, 2], [0, 1.1, 1.9], func=expr)
+pred = reg.predict([0.5, 1.5])
+```
+
+## Optional matplotlib and sympy patches
+
+Importing `unc_tools.patches` monkey-patches matplotlib `Axes.scatter`/`Axes.plot`
+and adds uncertainty-aware helpers for sympy substitution/lambdify. This is a
+global side effect and should be enabled explicitly:
+
+```python
+import unc_tools.patches  # noqa: F401
+```
+
+## Public API
+
+- `UncRegression`: regression with uncertainty propagation.
+- `FunctionBase1D`, `Poly`, `Hyper`: symbolic helpers for 1D expressions.
+- `DataError`, `ExpressionError`, `InitialGuessError`, `ModelTypeError`: custom exceptions.
+
+
+## License
+
+This project is licensed under the MIT License.

uncertainty_tools-0.0.1/README.md

@@ -0,0 +1,55 @@
+# unc_tools
+
+Utilities for uncertainty-aware regression and symbolic function helpers.
+
+Python version: 3.10+
+
+## Install (uv)
+
+```bash
+uv venv
+uv pip install -e .
+```
+
+## Install (pip)
+
+```bash
+pip install unc_tools
+```
+
+## Usage
+
+```python
+from unc_tools import FunctionBase1D, Poly, UncRegression
+
+# Symbolic expression with coefficients.
+expr = FunctionBase1D("a*x + b")
+
+# Polynomial helper.
+poly = Poly(2)
+
+# Regression with uncertainty propagation.
+reg = UncRegression([0, 1, 2], [0, 1.1, 1.9], func=expr)
+pred = reg.predict([0.5, 1.5])
+```
+
+## Optional matplotlib and sympy patches
+
+Importing `unc_tools.patches` monkey-patches matplotlib `Axes.scatter`/`Axes.plot`
+and adds uncertainty-aware helpers for sympy substitution/lambdify. This is a
+global side effect and should be enabled explicitly:
+
+```python
+import unc_tools.patches  # noqa: F401
+```
+
+## Public API
+
+- `UncRegression`: regression with uncertainty propagation.
+- `FunctionBase1D`, `Poly`, `Hyper`: symbolic helpers for 1D expressions.
+- `DataError`, `ExpressionError`, `InitialGuessError`, `ModelTypeError`: custom exceptions.
+
+
+## License
+
+This project is licensed under the MIT License.

uncertainty_tools-0.0.1/pyproject.toml

@@ -0,0 +1,48 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "uncertainty_tools"
+version = "0.0.1"
+description = "Utilities for uncertainty-aware regression and symbolic function helpers."
+readme = "README.md"
+requires-python = ">=3.10"
+authors = [{ name = "Savateykin Yaroslav", email = "yaroslavsavateikinwork@yandex.ru" }]
+license = { file = "LICENSE" }
+classifiers = [
+  "Intended Audience :: Science/Research",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Scientific/Engineering :: Mathematics",
+  "Typing :: Typed",
+]
+dependencies = [
+  "matplotlib>=3.7",
+  "numpy>=1.23",
+  "pandas>=1.5",
+  "scipy>=1.10",
+  "sympy>=1.11",
+  "uncertainties>=3.1",
+]
+
+[project.optional-dependencies]
+test = ["pytest>=7.0"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["unc_tools"]
+include = ["unc_tools/py.typed", "LICENSE"]
+
+[tool.hatch.build.targets.sdist]
+include = ["LICENSE", "README.md", "pyproject.toml", "unc_tools/**"]
+exclude = [
+  "build/**",
+  "notebooks/**",
+  "tests/**",
+  "uv.lock",
+  "venv/**",
+  "**/__pycache__/**",
+]

uncertainty_tools-0.0.1/unc_tools/__init__.py

@@ -0,0 +1,26 @@
+"""Public package interface for uncertainty-aware tools."""
+
+from __future__ import annotations
+from importlib.metadata import PackageNotFoundError, version
+
+from .default_functions import FunctionBase1D, Hyper, Poly
+from .exceptions import DataError, ExpressionError, InitialGuessError, ModelTypeError
+from .unc_regression import UncRegression
+
+
+try:
+    __version__ = version("uncertainty_tools")
+except PackageNotFoundError:
+    __version__ = "unknown"
+
+__all__ = [
+    "DataError",
+    "ExpressionError",
+    "FunctionBase1D",
+    "Hyper",
+    "InitialGuessError",
+    "ModelTypeError",
+    "Poly",
+    "UncRegression",
+    "__version__",
+]