ligo-fir
A package for FIR filter functionality needed by LIGO applications such as pydarm or sgn-cal.
Installation
On Unix systems, you can install directly from PyPI:
pip install ligo-fir
Alternatively, install from conda-forge:
conda install -c conda-forge ligo-fir
See INSTALL.md for installing from source and for development setups.
Basic usage
from ligo_fir import FIRfilter
# configure the filter geometry: sample rate, length, low-frequency roll-off
fir = FIRfilter(fNyq=8192, desired_dur=1.0, highpass_fcut=9.0)
# evaluate your frequency-domain model on fir.freq_array, then convert it
model = my_transfer_function(fir.freq_array)
model_FIR, double_model, window = fir.create_fir_filter(model)
See the web-based documentation for
a fuller walkthrough of filter generation and of the FFT, window and resampling
routines in ligo_fir.firtools. You can use ligo-fir either from python,
ipython, or a jupyter notebook, depending on your preferences.
Documentation
The documentation is available at here.
It is built with Sphinx from the
docs/ directory. To build it locally:
python -m pip install -e ".[docs]"
make docs
The result lands in docs/_build/html/index.html.
1 maintainer
Metadata
1 maintainer
Release files for ligo-fir 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ligo_fir-0.1.0.tar.gz | 248.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ligo_fir-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 277.5 kB
Release files / ligo_fir-0.1.0.tar.gz
| Download URL | ligo_fir-0.1.0.tar.gz |
|---|---|
| Size | 248.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fcf51f44448a4d6176825d5b726bb9d3035a7d53fb336ef6fd02bdbf30450f21
|
|
BLAKE2b-256 checksum How to use checksums |
7f79069f920430769855924405632e6e193872445606fc4637657a2be98a0424
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.12
|
Release files / ligo_fir-0.1.0-py3-none-any.whl
| Download URL | ligo_fir-0.1.0-py3-none-any.whl |
|---|---|
| Size | 29.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7ff04b4ce5310160a74b7dac892329bc45bb902bbeb48c6e9473dce533d443b2
|
|
BLAKE2b-256 checksum How to use checksums |
e805743bf5ac39b3197f03d121cb057380256a6ddbe052074461c1af2032728e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.12
|
