Metadata-Version: 2.4
Name: franc
Version: 0.3.2
Summary: Evaluation framework for noise mitigation methods and implementations of different static and adaptive filtering techniques.
Project-URL: Repository, https://github.com/NewtonianNoise/franc
Project-URL: Documentation, https://franc.readthedocs.io/en/latest/
Author-email: Tim Kuhlbusch <kuhlbusch@physik.rwth-aachen.de>
License-Expression: GPL-3.0-only
License-File: LICENSE
Keywords: LeastMeanSquares,Wiener filter,filtering,noise cancellation,prediction
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: <3.14,>=3.10
Requires-Dist: icecream
Requires-Dist: matplotlib
Requires-Dist: numba
Requires-Dist: numpy>=2.0.0
Requires-Dist: psutil~=5.8
Requires-Dist: scipy
Requires-Dist: spicypy~=0.9
Provides-Extra: dev
Requires-Dist: black>=20.8; extra == 'dev'
Requires-Dist: coverage>=5.1; extra == 'dev'
Requires-Dist: mypy>=1.15; extra == 'dev'
Requires-Dist: pylint>=3.0.3; extra == 'dev'
Requires-Dist: pytest>=7.4; extra == 'dev'
Requires-Dist: sphinx-autoapi~=3.3; extra == 'dev'
Requires-Dist: sphinx-rtd-theme; extra == 'dev'
Description-Content-Type: text/markdown

# FraNC - Framework for Noise Cancellation in gravitational wave detection

![Test status](https://github.com/NewtonianNoise/franc/actions/workflows/testing.yml/badge.svg)
![Linting status](https://github.com/NewtonianNoise/franc/actions/workflows/pylint.yml/badge.svg)
![Static type check status](https://github.com/NewtonianNoise/franc/actions/workflows/mypy.yml/badge.svg)

A framework to develop and evaluate noise cancellation techniques.
Includes python implementations of different static and adaptive filtering techniques.
The techniques for the prediction of a correlated signal component from witness signals provide a unified interface.

[Documentation](https://franc.readthedocs.io/en/latest/)

## Install

From pypi: `pip install franc`

From repository: `pip install .`

From repository (editable): `pip install hatchling ninja && make ie`

## License

Copyright (C) 2025  Tim J. Kuhlbusch et al.

```
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <https://www.gnu.org/licenses/>.
```
