Revision 7d0111900e681d8c0da9bb6b47cad3b1166793c6 authored by Collin Capano on 23 September 2020, 15:06:38 UTC, committed by GitHub on 23 September 2020, 15:06:38 UTC
1 parent 08945c8
index.rst
=======
PyCBC
=======
PyCBC is a software package used to explore astrophysical sources of gravitational waves.
It contains algorithms that can detect coalescing compact binaries and measure
the astrophysical parameters of detected sources. PyCBC was used
in the `first direct detection of gravitational waves (GW150914) by
LIGO <https://journals.aps.org/prl/abstract/10.1103/PhysRevLett.116.061102>`_ and
is used in the ongoing analysis of LIGO and Virgo data.
If you use PyCBC in your scientific publications or projects,
we ask that you acknowlege our work by citing the papers described on the page:
.. toctree::
:maxdepth: 1
credit
===============
Getting Started
===============
- Get the full PyCBC software suite with one of our Docker Images
If you have `Docker <https://www.docker.com/community-edition>`_ installed, you can get started using PyCBC with just two commands:
.. raw:: html
<script type="text/javascript">
document.addEventListener("DOMContentLoaded", function(){
Typed.new(".element", {
strings: ["^500<strong>docker pull pycbc/pycbc-el7:latest</strong><br>$ ^500<strong>docker run -it pycbc/pycbc-el7:latest</strong><br>(pycbc-software)[pycbc@37184573e664 ~]$ ^500<strong>python</strong><br>Python 2.7.5 (default, Nov 6 2016, 00:28:07)<br>[GCC 4.8.5 20150623 (Red Hat 4.8.5-11)] on linux2<br>>>> ^500<strong>execfile("/opt/pycbc/src/pycbc/examples/waveform/match_waveform.py")</strong><br>^1000The match is: 0.953<br>>>> ^500<strong>from pycbc.waveform import td_approximants</strong><br>>>> ^500<strong>print td_approximants()[20:24]</strong><br>['SEOBNRv3', 'SEOBNRv2', 'SpinTaylorT1', 'SEOBNRv4']<br>>>> "],
typeSpeed: 0
});
});
</script>
<div class="text-editor-wrap">
<div class="title-bar"><span class="title">pycbc — bash — 80x<span class="terminal-height">25</span></span></div>
<div class="text-body">
$ <span class="element"></span>
</div>
</div>
<br>
<br>
For more details, including instructions on starting a container that can display graphics, see:
.. toctree::
:maxdepth: 1
docker
- Use the PyCBC Library within your Browser
We have interactive jupyter notebooks on azure where you can try some of our
examples, and use the pycbc library. All from within the browser.
`Give it a try <https://notebooks.azure.com/nitz/libraries/pycbc>`_
=====================
Installation
=====================
Note, if you are a LIGO / Virgo member with access to LDG resources, PyCBC is *already*
installed on your cluster through CVMFS! Instructions to source any release of PyCBC
is available from the `releases page <https://github.com/ligo-cbc/pycbc/releases>`_.
You may also install PyCBC directly with pip. You may ommit `lalsuite` if you have
your own build.
.. code-block:: bash
pip install lalsuite pycbc
Full detailed installation instructions which covers other installation cases:
.. toctree::
:maxdepth: 1
install
====================================================
Parameter Estimation of Gravitational-wave Sources
====================================================
Users who want to create and run parameter estimation workflows should read the
documentation at:
.. toctree::
:maxdepth: 2
inference
==========================================
Searching for Gravitational-wave Signals
==========================================
Users who want to create and run scientific workflows to search for compact
binaries should read the documentation in the links at:
.. toctree::
:maxdepth: 1
workflow/pycbc_make_psd_estimation_workflow
workflow/pycbc_make_coinc_search_workflow
workflow/pygrb.rst
===================================================
Template Banks, Hardware Injections, and more...
===================================================
Users who are interested in tools that PyCBC provides for various other
analysis tasks (e.g. template bank generation, hardware injections, and testing
template banks) should read the documentation at:
.. toctree::
:maxdepth: 1
tmpltbank
hwinj
banksim
faithsim
upload_to_gracedb
==========================================
Extending PyCBC with external plugins
==========================================
Would you like to use a waveform model that PyCBC doesn't have? Or maybe
you have your own waveform you'd like to use for a search, parameter estimation
, etc. PyCBC supports a plug-in archictecture for external waveform models.
.. toctree::
:maxdepth: 1
waveform_plugin
==========================================
Library Examples and Interactive Tutorials
==========================================
We have interactive tutorials and examples of using the pycbc library hosted
on azure jupyter notebooks. `Please give them a try. <https://notebooks.azure.com/nitz/libraries/pycbc>`_
In addition we have some examples below.
.. toctree::
:maxdepth: 2
catalog
dataquality
frame
gw150914
detector
psd
noise
waveform
filter
distributions
=============================
Documentation for Developers
=============================
Documentation on building stand-alone bundled executables with PyInstaller is available at:
.. toctree::
:maxdepth: 1
building_bundled_executables
PyCBC developers should read the pages below which explain how to write
documentation, develop the code, and create releases:
.. toctree::
:maxdepth: 1
documentation
release
Developers who are interested in file I/O, data storage, and access should
read the documentation at:
.. toctree::
:maxdepth: 1
formats/hdf_format
Developers who are interested in creating new scientific workflow generation
scripts should read the documentation at:
.. toctree::
:maxdepth: 1
workflow
Full Module Documentation is available at:
.. toctree::
:maxdepth: 1
modules
===================
Indexes and Tables
===================
* :ref:`modindex`
* :ref:`genindex`
Computing file changes ...
