Skip to main content

Fscan

PyPI version Conda PyPI - License PyPI - Python Version

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

Installation

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

conda install -c conda-forge fscan

Or from PyPI:

pip install fscan

LALPulsar and lalframe are required for running but optional dependencies. You may either install it into the environment using

conda install -c conda-forge fscan[conda]

or install LALSuite from source.

Running Fscan

Fscan runs on LIGO site computing resources (LHO, LLO, or CIT) by accessing the frame files directly on-disk (not via NDS). The main way to run Fscan is using the FscanDriver program on the command line together with arguments that tell Fscan how to run.

One key argument is the channel configuration file. This file contains the information needed on how the Fscan program finds and processes data on an individual channel basis. Example channel configuration files may be found here.

Example running Fscan

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

FscanDriver --chan-opts=fscan-configuration/configuration/examples/example_ch_info.yml --SFTpath=. --create-sfts=1 --plot-output=1 --accounting-group=ligo.dev.o4.detchar.linefind.fscan --accounting-group-user=albert.einstein --analysisStart=20200229 --analysisDuration=1day --averageDuration=1day

Another example (using a configuration file)

Running from the Fscan source directory,

FscanDriver --config configuration/example.config

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

Metadata

Release files for fscan 0.6.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for fscan 0.6.4
File Size Uploaded
fscan-0.6.4.tar.gz 112.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for fscan 0.6.4
File Interpreter ABI Platform
fscan-0.6.4-py3-none-any.whl Python 3 none any Details

Total release size: 227.3 kB

Release files / fscan-0.6.4.tar.gz

Download URL fscan-0.6.4.tar.gz
Size 112.9 kB
Tags Source
SHA-256 checksum
How to use checksums
e1fbbd16e530357317d21196128497687621a330ffe0d56a0f7f6c1b77989f8d
BLAKE2b-256 checksum
How to use checksums
74eb1df01864a82ce59765e4edff8a63d225ae6ee70bb4a52d2ad1ee05be8731
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.5

Release files / fscan-0.6.4-py3-none-any.whl

Download URL fscan-0.6.4-py3-none-any.whl
Size 114.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b8c2b828f370d9d5a18d095b547495740976a155b67b60b210e74ab60124bce9
BLAKE2b-256 checksum
How to use checksums
cbe228bd3756151982eaeea6fc6a271ee4e10a4c2eabc4106df4f767a8f036da
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.5

Release history Release notifications | RSS feed

This release

0.6.4 This release

2 release files

0.6.3

2 release files

0.6.2

2 release files

0.6.1

2 release files

0.6.0

2 release files

0.5.3

2 release files

0.5.2

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.6

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page