Metadata-Version: 2.1
Name: pydagogy-brent
Version: 0.0.1
Summary: Brent's algorithm
Home-page: https://github.com/denisrosset/brent-level-2.git
License: MIT
Author: Denis Rosset
Author-email: physics@denisrosset.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: rich (>=12.0.0,<13.0.0)
Project-URL: Repository, https://github.com/denisrosset/brent-level-2.git
Description-Content-Type: text/markdown

# Brent algorithm

## To install

Brent's algorithm requires `Python 3.8` and the [rich](https://github.com/Textualize/rich) library.

To install the library, run:

```bash
pip install pydagogy-brent
```

Then run the following in a Python shell:

```python
from pydagogy_brent import Settings, brent
import math
settings = Settings(x_rel_tol=1e-12, x_abs_tol=1e-12, y_tol=1e-12, verbose=True)
f = math.cos
brent(f, 0.0, 3.0, settings)
```


## To develop

We use the [Poetry](https://python-poetry.org/) dependency management system.

We use [VS Code](https://code.visualstudio.com/), the Black/isort/pylint tools. To install them, run:

```bash
poetry install 
```

