Metadata-Version: 2.1
Name: gwbench
Version: 0.7.0
Summary: A Python package for gravitational-wave benchmarking, particularly with Fisher information matrices.
Project-URL: Homepage, https://gitlab.com/sborhanian/gwbench
Project-URL: Bug Tracker, https://gitlab.com/sborhanian/gwbench/-/issues
Author-email: Ssohrab Borhanian <sborhanian@gmail.com>
License-File: AUTHORS.md
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Requires-Dist: astropy
Requires-Dist: dill
Requires-Dist: lalsuite
Requires-Dist: mpmath
Requires-Dist: numdifftools
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: scipy
Requires-Dist: sympy
Requires-Dist: tqdm
Description-Content-Type: text/markdown

# **BEWARE - Please Update to Version 0.7.0 or higher**
#### The sky area calculation was fixed in Version 0.65 and the matrix inversion was improved in 0.7.0 (refer to respective CHANGELOG.md entries)

# gwbench

## Acknowledgment

We request that any academic report, publication, or other academic
disclosure of results derived from the use of this software acknowledge
the use of the software by an appropriate acknowledgment or citation.

The gwbench software can be cited from [arXiv:2010.15202](https://arxiv.org/abs/2010.15202), with INSPIRE BibTeX entry:
```
@article{Borhanian:2020ypi,
    author = "Borhanian, Ssohrab",
    title = "{gwbench: a novel Fisher information package for gravitational-wave benchmarking}",
    eprint = "2010.15202",
    archivePrefix = "arXiv",
    primaryClass = "gr-qc",
    month = "10",
    year = "2020"
}
```

## Installation from source

### Clone the `gwbench` repository and enter it
Clone this repository and follow the next steps.
```
git clone https://gitlab.com/sborhanian/gwbench.git
cd gwbench
```

### Using `conda`

#### Source Oasis Conda - *do this first; only on LIGO clusters needed*
```
source /cvmfs/oasis.opensciencegrid.org/ligo/sw/conda/etc/profile.d/conda.sh  
which conda
```

The last line should print `/cvmfs/oasis.opensciencegrid.org/ligo/sw/conda/condabin/conda` or similar.

#### Setup conda virtual environment
```
conda create -y --name gwbench python=3.7  
conda activate gwbench  
conda install -y -c conda-forge --file requirements_conda.txt  
```

### Using `python -m venv` and `pip`
Replace `~/gwbench` with the appropriate path of choice in the following instructions:
```
python3 -m venv ~/gwbench
source ~/gwbench/bin/activate
pip install -r requirements_pip.txt
```

### Using `pip` or `conda`
Install while the virtual environment is active:
```
pip install .
```

### Uninstall
```
pip uninstall gwbench
```

### Test
```
cd example_scripts  
python quick_start.py
```
