Metadata-Version: 2.1
Name: TNAgen
Version: 0.0.1
Summary: A package that generates transient noise artifacts in gravitational-wave detector data.
Home-page: https://github.com/sStaite/TNAgen
Author: ['Seamus Staite', 'Jade Powell']
Author-email: Seamus Staite <seamus.staite@gmail.com>, Jade Powell <jade.powell@ligo.org>
Project-URL: homapage, https://github.com/sStaite/TNAgen
Project-URL: sourcecode, https://github.com/sStaite/TNAgen
Project-URL: documentation, https://tnagen.readthedocs.io/en/latest/
Keywords: gravitational-wave,noise artifacts,GANs
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10.8
Description-Content-Type: text/markdown
License-File: LICENSE.txt



# TNAgen
## Introduction
TNAgen is a python package that allows users to generate transient noise artifacts in gravitational-wave detector data using a GAN model. The package is based on the paper "Generating Transient Noise Artefacts in Gravitational-Wave Detector Data with Generative Adversarial Networks" by Powell et. al. It uses the torchGAN library to implement the GAN model and provides a user-friendly interface for generating noise artifacts for specific glitches.

## Table of contents
* [Installation](#Installation)
* [Documentation](#Documentation)
* [Contributors](#Contributors)

## Installation

This package must be installed through conda, due to the dependencies of this package. 
To create a new environment for this package:
```console
$ conda env create --name myenv --file=requirements.yml
$ conda activate myenv
```

To install:
```console
$ conda install TNAgen
```

From Source:
```console
$ git clone https://github.com/sStaite/TNAgen
$ cd TNAgen
$ python3 -m pip install --upgrade build
$ python3 -m build
```

## Documentation
Documentation can be found at https://tnagen.readthedocs.io/


## Contributors
Seamus Staite, Jade Powell

