Metadata-Version: 2.4
Name: cows3
Version: 0.0.3
Summary: Continuous-wave search sensitivity simulator
Author-email: Rodrigo Tenorio <rodrigo.tenorio.marquez@gmail.com>, Lorenzo Mirasola <loremira98@tiscali.it>
License: MIT License
        
        Copyright (c) 2024 Rodrigo Tenorio, Lorenzo Mirasola
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        
        
Project-URL: Homepage, https://github.com/Rodrigo-Tenorio/cows3
Project-URL: Issues, https://github.com/Rodrigo-Tenorio/cows3/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: lalsuite
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: solar_system_ephemerides
Provides-Extra: dev
Requires-Dist: black; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Dynamic: license-file

# Continuous-wave search sensitivity simulator (cows3)
[![DOI](https://zenodo.org/badge/DOI/10.1103/PhysRevD.110.124049.svg)](https://doi.org/10.1103/PhysRevD.110.124049)
[![PyPI version](https://badge.fury.io/py/cows3.svg)](https://badge.fury.io/py/cows3)
[![DOI](https://zenodo.org/badge/802506306.svg)](https://zenodo.org/badge/latestdoi/802506306)
[![arXiv](https://img.shields.io/badge/arXiv-2405.18934-b31b1b.svg)](https://arxiv.org/abs/2405.18934)

A Python package to estimate the sensitivity of general
continuous gravitational-wave searches.

The method should be equivalent to the semi-analytical approach derived in
[Dreissigacker, Prix, Wette (2018)](https://arxiv.org/abs/1808.02459) and
implemented in [Octapps](https://github.com/octapps/octapps), but here we 
implement it in Python to make it more convenient to use.

## How to install 

`cows3` is available under PyPI:

```
pip install cows3
```


## Citing this work

If `cows3` was useful to your research, we would appreciate if you cited
[Mirasola & Tenorio (2024)](https://arxiv.org/abs/2405.18934) where this
implementation was first presented:
```
@article{Mirasola:2024lcq,
    author = "Mirasola, Lorenzo and Tenorio, Rodrigo",
    title = "{Toward a computationally efficient follow-up pipeline for blind continuous gravitational-wave searches}",
    eprint = "2405.18934",
    archivePrefix = "arXiv",
    primaryClass = "gr-qc",
    reportNumber = "LIGO-P2400221",
    doi = "10.1103/PhysRevD.110.124049",
    journal = "Phys. Rev. D",
    volume = "110",
    number = "12",
    pages = "124049",
    year = "2024"
}

```
as well as a Zenodo release of this software.

For the semi-analytical sensitivity estimation method you should also cite 
[Wette (2012)](https://arxiv.org/abs/1111.5650) and
[Dreissigacker, Prix, Wette (2018)](https://arxiv.org/abs/1808.02459). Also,
this package makes extensive use of SWIG bindings, so please cite
[Wette (2021)](https://arxiv.org/abs/2012.09552) as well.


## Authors
- Rodrigo Tenorio
- Lorenzo Mirasola


