Metadata-Version: 2.4
Name: fscan
Version: 0.4.0
Summary: Fscan tool for monitoring narrow spectral artifacts in LIGO data
Author-email: Evan Goetz <evan.goetz@ligo.org>, Ansel Neunzert <ansel.neunzert@ligo.org>, Sudhagar Suyamprakasam <sudhagar.suyamprakasam@ligo.org>
License-Expression: GPL-3.0-or-later
Project-URL: Source Code, https://git.ligo.org/CW/instrumental/fscan
Project-URL: Bug Tracker, https://git.ligo.org/CW/instrumental/fscan/-/issues
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: bokeh>=3.7.2
Requires-Dist: gwdetchar
Requires-Dist: gpstime
Provides-Extra: test
Requires-Dist: flake8; extra == "test"
Provides-Extra: conda
Requires-Dist: lalpulsar>=6.0.4; extra == "conda"
Dynamic: license-file

# Fscan

[![PyPI version](https://badge.fury.io/py/fscan.svg)](https://badge.fury.io/py/fscan)
![Conda](https://img.shields.io/conda/v/conda-forge/fscan?label=conda-forge)
![PyPI - License](https://img.shields.io/pypi/l/fscan)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fscan)

Fscan pipeline for characterizing persistent narrowband spectral artifacts in gravitational wave detector data

## Installation

On Unix systems, Fscan can be installed easily using PyPI:

```shell
pip install fscan
```

## Example for running Fscan

Run the `FscanDriver <args>` exectuable with appropriate arguments (see `FscanDriver -h` for additional details). For example at CIT:

```bash
$ FscanDriver -C 1 -O 1 -A ligo.dev.o4.detchar.linefind.fscan -U albert.einstein --full-band-avg=1 --analysisStart=20200229 --analysisDuration=1day --averageDuration=1day -y fscan/configuration/examples/example_ch_info.yml -f .
```

### Another example (using a configuration file)

Running from the Fscan source directory,

```bash
FscanDriver --config configuration/example.config
```

Be sure to edit the arguments in `example.config` to reflect the locations of your lalsuite and fscan installations.
