GWpy can be installed using pip:
pip install gwpy
This will install GWpy itself and all required dependencies for minimal functionality.
Those dependencies are:
dateutilnumpyscipymatplotlibastropyglueligotimegps (if lal is not already installed)See the GWpy setup.py file for minimum version requirements for each of those packages.
Additional (optional) functionality can be installed by specifying one or more of the extra group names, as follows
| Group name | Purpose | Packages included |
|---|---|---|
hdf5 |
Reading/writing HDF5 files Querying for open-access LIGO data |
h5py |
root |
Reading/writing ROOT files | root_numpy |
segments |
Querying for LIGO operations and data-quality segments (requires LIGO.ORG credentials) | dqsegdb |
hacr |
Querying for HACR event files | MySQLdb |
docs |
Generating package documentation | sphinx, numpydoc,
sphinx-bootstrap-theme,
sphinx-programoutput,
sphinx-automodapi |
all |
All of the above extras | All of the above |
Any of these extras can be installed with pip:
pip install gwpy[all]
GWpy functionality can also be extended with a number of non-python extensions, most of which provide python bindings via SWIG:
| Package | Purpose |
|---|---|
LDAStools.frameCPP |
Reading/writing GWF files |
lal |
Signal-processing |
lalframe |
Reading/writing GWF files |
nds2 |
Querying for LIGO data over a network |
Each of the above is provided by the LIGO Scientific Collaboration, and can be installed using the recommended package manager for your operating system. See below for useful links provided by the LSC Computing group:
| OS | Package manager | Useful link |
|---|---|---|
| macOS | MacPorts | https://wiki.ligo.org/DASWG/MacPorts |
| Debian/Ubuntu | Apt | https://wiki.ligo.org/DASWG/DebianJessie |
| Red Hat/Fedora | Yum | https://wiki.ligo.org/DASWG/ScientificLinux |
If you are a member of the LIGO Scientific Collaboration, a virtualenv is available for you to use on the LIGO Data Grid, providing an isolated environment including GWpy and its dependencies.
How you enter this environment depends on which shell you are using:
Bash
. ~detchar/opt/gwpysoft/bin/activate
Csh
. ~detchar/opt/gwpysoft/bin/activate.csh
In either case, once you are finished with your work, if you want to return to your original environment, you can deactivate the virtualenv:
deactivate