rtfilter 0.1.0

Real-time filters for signal processing.

Real-Time Filter

Real-Time Filter

Real-time filters for signal processing.
Explore the docs »

Table of Contents

1. About The Project
2. Contact
3. Getting Started
   • Development Installation
   • Package Installation
4. Usage
5. License
6. Acknowledgments

About The Project

Give a brief introduction into the project.

Contact

Dominik I. Braun - [e-mail]

Project Link: https://github.com/NsquaredLab/Real-Time-Filter

Getting Started

The local set up is made using Poetry. You can install Poetry using the following command. Note: It is recommeded to install it globally.

pip install poetry

Then, you can install the dependencies in your work area using the following command:

poetry install

Development installation

If you want to contribute to the project, you can install the development dependencies using the following command:

poetry install --with dev,docs

Package Installation

Poetry

poetry add git+https://github.com/NsquaredLab/Real-Time-Filter.git

poetry add rtfilter

PIP

pip install git+https://github.com/NsquaredLab/Real-Time-Filter.git

pip install rtfilter

Usage

TBD

License

Distributed under the GPL-3.0 license License. See LICENSE.txt for more information.

Acknowledgments

(back to top)