Metadata-Version: 2.4
Name: GWget
Version: 0.0.1
Summary: Automatic downloader of LVK GW posterior samples and injections from Zenodo
Author-email: Stefano Rinaldi <stefano.rinaldi@uni-heidelberg.de>
License: MIT License
        
        Copyright (c) 2026 Stefano Rinaldi
        
        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: Repository, https://github.com/sterinaldi/gwget.git
Project-URL: Issues, https://github.com/sterinaldi/gwget/issues
Keywords: GW,gravitational waves,LVK,zenodo,samples
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: zenodo-get>3.0.1
Dynamic: license-file

# GWget

GWget automatises the download of the PE samples and sensitivity estimate files released as part of the different iterations of the GWTC catalogue by the LIGO-Virgo-KAGRA collaboration. These files are scattered around a number of Zenodo repositories and in a number of different versions: this package is an effort to simplify the collection of the files necessary to perform population studies.

GWget comes with two command-line interfaces: 
    - `gwget [-o OUTPUT -c CATALOGUE --no_injections]` downloads the files corresponding to the specified GWTC (default: latest). In addition to this, it creates additional sub-catalogues with symlinks pointing at the BBH events used for population studies of GWTC-3, GWTC-4 and GWTC-5.
    - `makecat -e FOLDER -l LIST` can be used to create a custom sub-catalogue with the events specified in a `.txt` file (e.g., for ad-hoc studies).
Beware that, as of today, the total size of the files that are downloaded by default is around 130 GB, and it can take quite a while to finish. 
You can install GWget either via pip
```
pip install gwget
```
or from the repository
```
git clone git@github.com:sterinaldi/gwget.git
cd gwget
pip install .
```
***Disclaimer:*** this repository is not mantained nor endorsed by the LVK collaboration nor any of its members and it is provided *as-is*, with no guarantees (other than the best effort of the author, who uses this very routine in his papers) of correctness and absence of bugs.
