Metadata-Version: 2.4
Name: uncertainty_tools
Version: 0.1.0
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.12
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: matplotlib>=3.7
Requires-Dist: numpy>=1.23
Requires-Dist: pandas>=1.5
Requires-Dist: plotly>=6.5.2
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


# uncertainty-tools

Utilities for uncertainty-aware regression and symbolic function helpers.

**Python version:** 3.12+

> 📦 PyPI package name: `uncertainty-tools`  
> 🧩 Python import name: `unc_tools`

---

## Installation

### Using pip

```bash
pip install uncertainty-tools
````

### Using uv

```bash
uv add uncertainty-tools
```

--- 

## Notebooks

[link](https://github.com/yaroslavsavateykin/unc_tools/tree/main/notebooks)

---

## 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(
    x=[0, 1, 2],
    y=[0, 1.1, 1.9],
    func=expr,
)

pred = reg.predict([0.5, 1.5])
```

---

## Optional matplotlib patches

Importing `unc_tools.patches` monkey-patches only:

- `matplotlib.axes.Axes.scatter`
- `matplotlib.axes.Axes.plot`
    

It also exposes `new_subs` and `new_lambdify` helpers for explicit SymPy use.
Plotly and SymPy global APIs are not modified.

⚠️ This introduces **global side effects** and must be enabled explicitly:

```python
import unc_tools.patches  # noqa: F401
```

---

## Project status

⚠️ This project is under active development.  
The public API may change between minor versions.

---

## License

This project is licensed under the MIT License.
