Metadata-Version: 2.4
Name: fiddy
Version: 0.0.4
Summary: Finite difference methods
Author-email: The fiddy developers <dilan.pathirana@uni-bonn.de>
License-Expression: BSD-3-Clause
Project-URL: Homepage, https://github.com/icb-dcm/fiddy
Project-URL: Documentation, https://fiddy.readthedocs.io
Project-URL: Repository, https://github.com/icb-dcm/fiddy
Project-URL: Bug Tracker, https://github.com/icb-dcm/fiddy/issues
Keywords: finite difference,gradient check,difference quotient
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: joblib
Requires-Dist: numpy
Requires-Dist: pandas
Provides-Extra: all
Requires-Dist: notebook; extra == "all"
Requires-Dist: scipy; extra == "all"
Requires-Dist: pytest; extra == "all"
Requires-Dist: scipy; extra == "all"
Requires-Dist: sympy; extra == "all"
Requires-Dist: more-itertools; extra == "all"
Provides-Extra: doc
Requires-Dist: docutils<0.19; extra == "doc"
Requires-Dist: ipython; extra == "doc"
Requires-Dist: mock; extra == "doc"
Requires-Dist: nbconvert; extra == "doc"
Requires-Dist: nbsphinx; extra == "doc"
Requires-Dist: recommonmark>=0.7.1; extra == "doc"
Requires-Dist: sphinx<8; extra == "doc"
Requires-Dist: sphinx_rtd_theme; extra == "doc"
Requires-Dist: sphinx-autodoc-typehints; extra == "doc"
Provides-Extra: examples
Requires-Dist: notebook; extra == "examples"
Requires-Dist: scipy; extra == "examples"
Provides-Extra: tests
Requires-Dist: pytest; extra == "tests"
Requires-Dist: scipy; extra == "tests"
Requires-Dist: sympy; extra == "tests"
Requires-Dist: more-itertools; extra == "tests"
Dynamic: license-file

# fiddy

[![Test suite](https://github.com/ICB-DCM/fiddy/actions/workflows/test_suite.yml/badge.svg)](https://github.com/ICB-DCM/fiddy/actions/workflows/test_suite.yml)
[![PyPI](https://badge.fury.io/py/fiddy.svg)](https://badge.fury.io/py/fiddy)
[![Documentation](https://readthedocs.org/projects/fiddy/badge/?version=latest)](https://fiddy.readthedocs.io)

[Finite difference methods](https://en.wikipedia.org/wiki/Finite_difference),
for applications including gradient computation and gradient checks.

# Important notes

The output of your function of interest should be a NumPy array. If your function is scalar-valued, change it to a NumPy array with:
```python
import numpy as np

def function(input_value: float) -> np.ndarray:
    scalar_output_value = old_function(input_value)
    return np.array([scalar_output_value])
```

# Installation

Currently under development, please install from source.
```bash
pip install -e .
```

Can also be installed from [PyPI](https://pypi.org/project/fiddy/)
```bash
pip install fiddy
```
