Skip to content

Commit

Permalink
update documentation to point to pycbc.org instead of ligo-cbc.github…
Browse files Browse the repository at this point in the history
….io (#2119)

* remove install.sh

* add descr.rst

* update readme

* make documentation changes where possible to point to pycbc.org
  • Loading branch information
ahnitz committed Apr 5, 2018
1 parent a21cf52 commit 2537f80
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 29 deletions.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -36,7 +36,7 @@ A key for the latest release is available at:

[![DOI](https://zenodo.org/badge/31596861.svg)](https://zenodo.org/badge/latestdoi/31596861)

Please see our [citation guidelines](http://ligo-cbc.github.io/pycbc/latest/html/credit.html) for
Please see our [citation guidelines](http://pycbc.org/pycbc/latest/html/credit.html) for
more details.

[![PyPI version](https://badge.fury.io/py/PyCBC.svg)](https://badge.fury.io/py/PyCBC)
Expand Down
8 changes: 4 additions & 4 deletions descr.rst
@@ -1,7 +1,7 @@
`PyCBC <https://ligo-cbc.github.io>`_ is a software package used to explore astrophysical sources of gravitational waves. It contains algorithms to analyze gravitational-wave data from the LIGO and Virgo detectors, detect coalescing compact binaries, and measure the astrophysical parameters of detected sources. PyCBC was used in the `first direct detection of gravitational waves <https://journals.aps.org/prl/abstract/10.1103/PhysRevLett.116.061102>`_ and is used in the flagship analysis of LIGO and Virgo data.
`PyCBC <http://pycbc.org>`_ is a software package used to explore astrophysical sources of gravitational waves. It contains algorithms to analyze gravitational-wave data from the LIGO and Virgo detectors, detect coalescing compact binaries, and measure the astrophysical parameters of detected sources. PyCBC was used in the `first direct detection of gravitational waves <https://journals.aps.org/prl/abstract/10.1103/PhysRevLett.116.061102>`_ and is used in the flagship analysis of LIGO and Virgo data.

PyCBC is developed collaboratively and lead by a team of LIGO scientists with the aim to build accessible tools for gravitational-wave data analysis. One of the easiest ways to get a full software environment is by `downloading one of our docker images. <https://ligo-cbc.github.io/pycbc/latest/html/docker.html>`_
PyCBC is developed collaboratively and lead by a team of LIGO scientists with the aim to build accessible tools for gravitational-wave data analysis. One of the easiest ways to get a full software environment is by `downloading one of our docker images. <http://pycbc.org/pycbc/latest/html/docker.html>`_

Some interactive examples using portions of the PyCBC library are also hosted as jupyter notebooks on Microsoft Azure. `Feel free to give them a try. <https://notebooks.azure.com/nitz/libraries/pycbc>`_ You can also explore the `full documentation pages <https://ligo-cbc.github.io/pycbc/latest/html/index.html>`_ or the `source code on GitHub. <https://github.com/ligo-cbc/pycbc>`_
Some interactive examples using portions of the PyCBC library are also hosted as jupyter notebooks on Microsoft Azure. `Feel free to give them a try. <https://notebooks.azure.com/nitz/libraries/pycbc>`_ You can also explore the `full documentation pages <http://pycbc.org/pycbc/latest/html/index.html>`_ or the `source code on GitHub. <https://github.com/ligo-cbc/pycbc>`_

If you use PyCBC in scientific publications, please see our `citation guidelines. <https://ligo-cbc.github.io/pycbc/latest/html/credit.html>`_
If you use PyCBC in scientific publications, please see our `citation guidelines. <http://pycbc.org/pycbc/latest/html/credit.html>`_
10 changes: 5 additions & 5 deletions docs/resources/sbank_example1.ini
Expand Up @@ -2,15 +2,15 @@
;
; Template bank documentation can be found here:
;
; http://ligo-cbc.github.io/pycbc/latest/html/tmpltbank.html
; http://pycbc.org/pycbc/latest/html/tmpltbank.html
;
; Documentation for the PyCBC workflow module is here:
;
; http://ligo-cbc.github.io/pycbc/latest/html/workflow.html
; http://pycbc.org/pycbc/latest/html/workflow.html


[workflow]
; http://ligo-cbc.github.io/pycbc/latest/html/workflow/initialization.html
; http://pycbc.org/pycbc/latest/html/workflow/initialization.html

; What files to store? If this is set to "results" then only the final template
; bank will exist after the workflow completes.
Expand Down Expand Up @@ -54,7 +54,7 @@ l1 =
v1=

[executables]
; http://ligo-cbc.github.io/pycbc/latest/html/workflow/initialization.html
; http://pycbc.org/pycbc/latest/html/workflow/initialization.html

; All executables are listed here
sbank = ${which:lalapps_cbc_sbank}
Expand All @@ -63,7 +63,7 @@ h5add = ${which:lalapps_cbc_sbank_hdf5_bankcombiner}

; Then options for all executables are added. These are added directly to the
; jobs as described here:
; http://ligo-cbc.github.io/pycbc/latest/html/workflow/initialization.html
; http://pycbc.org/pycbc/latest/html/workflow/initialization.html
[sbank]
; Options for *all* sbank jobs

Expand Down
10 changes: 5 additions & 5 deletions docs/resources/sbank_example2.ini
Expand Up @@ -2,15 +2,15 @@
;
; Template bank documentation can be found here:
;
; http://ligo-cbc.github.io/pycbc/latest/html/tmpltbank.html
; http://pycbc.org/pycbc/latest/html/tmpltbank.html
;
; Documentation for the PyCBC workflow module is here:
;
; http://ligo-cbc.github.io/pycbc/latest/html/workflow.html
; http://pycbc.org/pycbc/latest/html/workflow.html


[workflow]
; http://ligo-cbc.github.io/pycbc/latest/html/workflow/initialization.html
; http://pycbc.org/pycbc/latest/html/workflow/initialization.html

; What files to store? If this is set to "results" then only the final template
; bank will exist after the workflow completes.
Expand Down Expand Up @@ -54,7 +54,7 @@ l1 =
v1=

[executables]
; http://ligo-cbc.github.io/pycbc/latest/html/workflow/initialization.html
; http://pycbc.org/pycbc/latest/html/workflow/initialization.html

; All executables are listed here
sbank = ${which:lalapps_cbc_sbank}
Expand All @@ -63,7 +63,7 @@ h5add = ${which:lalapps_cbc_sbank_hdf5_bankcombiner}

; Then options for all executables are added. These are added directly to the
; jobs as described here:
; http://ligo-cbc.github.io/pycbc/latest/html/workflow/initialization.html
; http://pycbc.org/pycbc/latest/html/workflow/initialization.html
[sbank]
; Options for *all* sbank jobs

Expand Down
10 changes: 5 additions & 5 deletions docs/resources/uberbank_example1.ini
Expand Up @@ -6,11 +6,11 @@
;
; Template bank documentation can be found here:
;
; http://ligo-cbc.github.io/pycbc/latest/html/tmpltbank.html
; http://pycbc.org/pycbc/latest/html/tmpltbank.html
;
; Documentation for the PyCBC workflow module is here:
;
; http://ligo-cbc.github.io/pycbc/latest/html/workflow.html
; http://pycbc.org/pycbc/latest/html/workflow.html

[common]
; Main options shared by different sections are gathered here
Expand All @@ -27,7 +27,7 @@ max-ns-spin = 0.05
nsbh-boundary = 2

[workflow]
; http://ligo-cbc.github.io/pycbc/latest/html/workflow/initialization.html
; http://pycbc.org/pycbc/latest/html/workflow/initialization.html

; Store only "merged_triggers" this means only final result files, and all key
; intermediate products.
Expand Down Expand Up @@ -88,7 +88,7 @@ h1 =
l1 =

[executables]
; http://ligo-cbc.github.io/pycbc/latest/html/workflow/initialization.html
; http://pycbc.org/pycbc/latest/html/workflow/initialization.html

; All executables are listed here, will be equivalent to `which exe`
sbank = ${which:lalapps_cbc_sbank}
Expand All @@ -99,7 +99,7 @@ geom_aligned_bank = ${which:pycbc_geom_aligned_bank}

; Then options for all executables are added. These are added directly to the
; jobs as described here:
; http://ligo-cbc.github.io/pycbc/latest/html/workflow/initialization.html
; http://pycbc.org/pycbc/latest/html/workflow/initialization.html

[sbank_workflow]
; Options to the workflow generator
Expand Down
8 changes: 0 additions & 8 deletions install_pycbc.sh

This file was deleted.

2 changes: 1 addition & 1 deletion pycbc/workflow/grb_utils.py
Expand Up @@ -25,7 +25,7 @@
"""
This library code contains functions and classes that are used in the
generation of pygrb workflows. For details about pycbc.workflow see here:
http://ligo-cbc.github.io/pycbc/latest/html/workflow.html
http://pycbc.org/pycbc/latest/html/workflow.html
"""

from __future__ import print_function
Expand Down

0 comments on commit 2537f80

Please sign in to comment.