Skip to content
Snippets Groups Projects
Commit 31bd9278 authored by James Clark's avatar James Clark
Browse files

Merge branch 'docs' into 'master'

corrected links to lscsoft, not james-clark

See merge request lscsoft/bayeswave!11
parents d8aeaab2 c3da74cd
No related branches found
No related tags found
No related merge requests found
......@@ -172,9 +172,9 @@ to build and test code whenever a commit is made (see e.g., "latest PDF" for
Here, we use the CI tools to automatically build and test BayesWave containers
following every commit. See
[`.gitlab-ci.yml`](https://git.ligo.org/james-clark/bayeswave/blob/master/.gitlab-ci.yml)
[`.gitlab-ci.yml`](https://git.ligo.org/lscsoft/bayeswave/blob/master/.gitlab-ci.yml)
for the CI script and
[`Dockerfile`](https://git.ligo.org/james-clark/bayeswave/blob/master/Dockerfile)
[`Dockerfile`](https://git.ligo.org/lscsoft/bayeswave/blob/master/Dockerfile)
for the container build instructions.
## Creating Your Own Docker Images
......@@ -212,7 +212,7 @@ resource in one go.
Note that detailed instructions for authentication can be found in the Registry
item of the gitlab side-bar.
In practice, this is handled most easily by the [CI script](https://git.ligo.org/james-clark/bayeswave/blob/master/.gitlab-ci.yml).
In practice, this is handled most easily by the [CI script](https://git.ligo.org/lscsoft/bayeswave/blob/master/.gitlab-ci.yml).
Alternatively, you may wish to deploy your images to dockerhub, which is
basically github for docker images. This makes them publicly available
......
......@@ -2,8 +2,8 @@
Use this if you're too busy to read / follow the sprawling instructions at:
* [Installation](https://git.ligo.org/james-clark/bayeswave/blob/master/doc/INSTALLATION.md)
* [Running Analyses](https://git.ligo.org/james-clark/bayeswave/blob/master/doc/RUNNING.md)
* [Installation](https://git.ligo.org/lscsoft/bayeswave/blob/master/doc/INSTALLATION.md)
* [Running Analyses](https://git.ligo.org/lscsoft/bayeswave/blob/master/doc/RUNNING.md)
## Install BayesWave
......
......@@ -26,18 +26,18 @@ MCMC configuration. The objective is to demonstrate the workflow, NOT a
scientific result. Please adjust the configuration file accordingly if you
desire science.
**Example directory:** This example lives in the repository [here](https://git.ligo.org/james-clark/bayeswave/tree/master/BayesWavePipe/examples/LDG-GW150914)
**Example directory:** This example lives in the repository [here](https://git.ligo.org/lscsoft/bayeswave/tree/master/BayesWavePipe/examples/LDG-GW150914)
This is the setup most LIGO users will be familiar with: clone a repository,
build and install software, execute an analysis.
Here, we assume you have compiled and installed an appropriate branch of
BayesWave and BayesWavePipe. See
[here](https://git.ligo.org/james-clark/bayeswave/blob/master/doc/INSTALLATION.md)
[here](https://git.ligo.org/lscsoft/bayeswave/blob/master/doc/INSTALLATION.md)
for installation information.
1. Copy
[this](https://git.ligo.org/james-clark/bayeswave/blob/master/BayesWavePipe/examples/LDG-GW150914/LDG-GW150914.ini)
[this](https://git.ligo.org/lscsoft/bayeswave/blob/master/BayesWavePipe/examples/LDG-GW150914/LDG-GW150914.ini)
configuration file to your working directory.
1. Modify paths in the `[engine]` section to point at the desired version of
the BayesWave executables and libraries.
......@@ -56,7 +56,7 @@ for installation information.
The configuration file specifies the various BayesWave commandline options, as
well as things like condor memory requests, accounting tags etc.
For convenience, this command is provided in [makework-LDG-GW150914.sh](https://git.ligo.org/james-clark/bayeswave/blob/master/BayesWavePipe/examples/LDG-GW150914/makework-LDG-GW150914.sh).
For convenience, this command is provided in [makework-LDG-GW150914.sh](https://git.ligo.org/lscsoft/bayeswave/blob/master/BayesWavePipe/examples/LDG-GW150914/makework-LDG-GW150914.sh).
This sets up four condor jobs:
1. `BayesWave`: main MCMC sampling.
......@@ -81,7 +81,7 @@ That's it! To start the analysis, simply follow the on-screen prompt:
## Analyze GW150914 Using A Container On The LDG
**Example directory:** This example lives in the repository [here](https://git.ligo.org/james-clark/bayeswave/tree/master/BayesWavePipe/examples/LDG-GW150914-singularity)
**Example directory:** This example lives in the repository [here](https://git.ligo.org/lscsoft/bayeswave/tree/master/BayesWavePipe/examples/LDG-GW150914-singularity)
We now repeat the example above using a singularity container. A full
discussion of containerization is (well) beyond the scope of this document but
......@@ -110,13 +110,13 @@ configuration file and point at the correct executables:
```
where the `[engine]` section of
[LDG-GW150914-singularity.ini](https://git.ligo.org/james-clark/bayeswave/blob/master/BayesWavePipe/examples/LDG-GW150914-singularity/LDG-GW150914-singularity.ini)
[LDG-GW150914-singularity.ini](https://git.ligo.org/lscsoft/bayeswave/blob/master/BayesWavePipe/examples/LDG-GW150914-singularity/LDG-GW150914-singularity.ini)
now contains the `use-singularity` option and the path to the desired
singularity image:
```
use-singularity=
singularity="/cvmfs/ligo-containers.opensciencegrid.org/james-clark/bayeswave:master"
singularity="/cvmfs/ligo-containers.opensciencegrid.org/lscsoft/bayeswave:master"
```
**Important Note**
......@@ -155,14 +155,14 @@ to access frame data. To run a singularity job which reads frames at CIT
singularity exec \
--writable \
--bind /hdfs \
/cvmfs/ligo-containers.opensciencegrid.org/james-clark/bayeswave:master \
/cvmfs/ligo-containers.opensciencegrid.org/lscsoft/bayeswave:master \
/opt/bayeswave/bin/BayesWave "$@"
```
## Analyze GW150914 On The OSG
**Example directory:** This example lives in the repository
[here](https://git.ligo.org/james-clark/bayeswave/tree/master/BayesWavePipe/examples/OSG-GW150914-singularity).
[here](https://git.ligo.org/lscsoft/bayeswave/tree/master/BayesWavePipe/examples/OSG-GW150914-singularity).
To add some variety, we'll now generate a workflow for 100 GPS times, rather
than a single follow-up. The times are given in the text file
[times.txt](https://git.ligo.org/jameacs-clark/bayeswave/blob/master/BayesWavePipe/examples/OSG-GW150914-singularity/times.txt).
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment