skip to navigation
skip to content

gwsurrogate 0.2.1

an easy to use interface to gravitational wave surrogate models

Latest Version: 0.6.3

Welcome to GWSurrogate!

GWSurrogate is an easy to use interface to gravitational wave surrogate models.

Surrogates provide a fast and accurate evaluation mechanism for gravitational
waveforms which would otherwise be found through solving differential
equations. These equations must be solved in the ``building" phase, which
was performed using other codes. For details see:

[1] Scott Field, Chad Galley, Jan Hesthaven, Jason Kaye, and Manuel Tiglio.
``Fast prediction and evaluation of gravitational waveforms using surrogate
models”, arXiv: gr-qc:1308.3565

If you find this package useful in your work, please cite reference [1] and,
if available, the relevant paper describing the specific surrogate used.

gwsurrogate is available at


gwsurrogate is a pure-Python module, thus installation is very easy.

From pip:

The python package pip supports installing from PyPI (the Python Package
Index). gwsurrogate can be installed to the standard location
(e.g. /usr/local/lib/pythonX.X/dist-packages) with

>>> pip install gwsurrogate

From source:

Download and unpack gwsurrogate-X.X.tar.gz to any folder gws_folder of your
choosing. The gwsurrogate module can be used immediately by adding

import sys

at the beginning of any script/notebook which uses gwsurrogate.

Alternatively, if you are a bash or sh user, edit your .profile
(or .bash_profile) file and add the line

export PYTHONPATH=~absolute_path_to_gws_folder:$PYTHONPATH

For a "proper" installation into gws_folder run

>>> python install --prefix=absolute_path_to_gws_folder

and edit the PYTHONPATH environment variable as described above.

Getting Started

Please read the gwsurrogate docstring found in the file
or from ipython with

>>> import gwsurrogate as gws
>>> gws?

Additional examples can be found in the accompanying ipython notebooks.

NSF Support

This package is based upon work supported by the National Science Foundation
under PHY-1316424 and PHY-1208861.

Any opinions, findings, and conclusions or recommendations expressed in
gwsurrogate are those of the authors and do not necessarily reflect the
views of the National Science Foundation.

Planned Development

-- Surrogate-specific parametric fitting functions
-- Amplitude and phase based surrogates
-- More descriptive surrogate names: EOBNRv2_q1to2_sA_0to0_0to0_0to0_sB_0to0_0to0_0to0_SingleModes
-- Direct generation of multi-mode surrogates with tensor harmonic weighting
-- adherence to pep standards
-- log files for all downloaded surrogates, and tools for viewing them
-- parameter array inputs for generating multiple surrogate evaluations
File Type Py Version Uploaded on Size
gwsurrogate-0.2.1.tar.gz (md5) Source 2014-06-19 3MB