Metadata-Version: 2.1
Name: mly_pipeline
Version: 0.9.2
Summary: Search pipeline to run online and offline GW searches with mly package.
Author-email: Vasileios SKliris <sklirisv@cardiff.ac.uk>
Keywords: ml,gravitational waves,bursts
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mly
Requires-Dist: spython
Requires-Dist: hermes.aeriel
Requires-Dist: hermes.quiver

# MLy-Pipeline

All-Sky burst search framework to use machine learning models.

## Installation

Create an virtual python environment with python version 3.8 to 3.10. 
Then install the hermes submodules that are used by the pipeline and currently are not on pypl
```bash
pip install "git+https://github.com/ML4GW/hermes.git@12e19f1#subdirectory=hermes/hermes.aeriel"
pip install "git+https://github.com/ML4GW/hermes.git@12e19f1#subdirectory=hermes/hermes.quiver"
pip install "git+https://github.com/ML4GW/hermes.git@12e19f1#subdirectory=hermes/hermes.stillwater"
```

Finally install the module
```bash
pip install mly-pipeline
```

## Usage

For the full documentation and usesage examples please refer to here: https://ldas-jobs.ligo.caltech.edu/~vasileios.skliris/mly-documentation/html/index.html
