Skip to content
Snippets Groups Projects
Commit abb025a4 authored by Patrick Godwin's avatar Patrick Godwin
Browse files

reorganize docs so information is easier to find

parent 8e4014ed
No related branches found
No related tags found
No related merge requests found
Pipeline #70405 canceled
Showing with 50 additions and 46 deletions
Overview
========
FIXME
Tutorials
=========
.. toctree::
:maxdepth: 1
gstlal_fake_data_overview
......@@ -10,26 +10,41 @@ Overview
The GstLAL software package is used for the following activities:
- **GstLAL:** The package `GstLAL <http://software.ligo.org/lscsoft/source/gstlal-1.4.1.tar.gz>`_ provides core Gstreamer plugins for signal processing workflows with LIGO data and core python bindings for constructing such workflows.
- ``gstlal`` provides core Gstreamer plugins for signal processing workflows with LIGO data and core python bindings for constructing such workflows.
- **GstLAL Calibration:** The package `GstLAL Calibration <http://software.ligo.org/lscsoft/source/gstlal-calibration-1.2.4.tar.gz>`_ provides real-time calibration of LIGO control system data into strain data.
- ``gstlal-calibration`` provides real-time calibration of LIGO control system data into strain data.
- **GstLAL Inspiral:** The package `GstLAL Inspiral <http://software.ligo.org/lscsoft/source/gstlal-inspiral-1.5.1.tar.gz>`_ provides additional signal processing plugins that are specific for LIGO / Virgo searches for compact binaries as well as a substantial amount of python code for post-processing raw signal processing results into gravitational wave candidate lists. Several publications about the methodology and workflow exist, see :ref:`publications`
- ``gstlal-inspiral`` provides additional signal processing plugins that are specific for LIGO / Virgo searches for compact binaries as well as a substantial amount of python code for post-processing raw signal processing results into gravitational wave candidate lists. Several publications about the methodology and workflow exist, see :ref:`publications`
- **GstLAL Ugly:** The package `GstLAL Inspiral <http://software.ligo.org/lscsoft/source/gstlal-inspiral-1.5.1.tar.gz>`_ is an incubator project for gradual inclusion in the other packages.
- ``gstlal-burst`` provides additional signal processing plugins for use in astrophysical and noise transient burst searches.
- ``gstlal-ugly`` is an incubator project for gradual inclusion in the other packages.
.. _welcome-contents:
Contents
-------------------------
.. toctree::
:caption: Getting Started
:maxdepth: 2
installation
quickstart
tutorials/tutorials
.. toctree::
:caption: User Guide
:maxdepth: 2
cbc_analysis
feature_extraction
fake_data
psd_estimation
publications
.. toctree::
:maxdepth: 2
:caption: API Reference
:maxdepth: 2
getting-started
projects
publications
executables
api
Build/Test Results
-------------------------
......
Getting started
Installation
===============
You can get a development copy of the gstlal software suite from git. Doing this at minimum will require a development copy of lalsuite.
......
Projects
========
.. toctree::
:maxdepth: 1
gstlal/gstlal
gstlal-inspiral/gstlal-inspiral
gstlal-calibration/gstlal-calibration
gstlal-burst/gstlal-burst
gstlal-ugly/gstlal-ugly
.. _psd-generation:
PSD Generation
================
WRITEME
.. _publications:
Publications
============
......
.. _quickstart:
Quickstart
============
WRITEME
......@@ -23,7 +23,7 @@ The basic steps to generate and validate LIGO colored noise are:
An example PSD plot:
.. image:: ../images/H1L1fakedataexamplepsd.png
.. image:: ../gstlal/images/H1L1fakedataexamplepsd.png
:width: 400px
Custom colored noise, i.e. simulate your own detector
......@@ -40,7 +40,7 @@ then you will need to first use gstlal_psd_xml_from_asd_txt to convert it
in the documentation include this)
1. Repeat the same validation steps as above to obtain, e.g.:
.. image:: ../images/V1fakedataexamplepsd.png
.. image:: ../gstlal/images/V1fakedataexamplepsd.png
:width: 400px
......
Documentation for running an offline compact binary coalescence analysis
Running an offline compact binary coalescence analysis
========================================================================
Prerequisites
......
####################################################################################################
Running Offline Jobs
Running offline feature extraction jobs
####################################################################################################
An offline DAG is provided in /gstlal-burst/share/feature_extractor/Makefile.gstlal_feature_extractor_offline
......
Documentation for starting an online compact binary coalescence analysis
Running an online compact binary coalescence analysis
========================================================================
Prerequisites
......
####################################################################################################
Running Online Jobs
Running online feature extraction jobs
####################################################################################################
An online DAG is provided in /gstlal-burst/share/feature_extractor/Makefile.gstlal_feature_extractor_online
......
......@@ -4,5 +4,8 @@ Tutorials
.. toctree::
:maxdepth: 1
gstlal_fake_data_overview
online_analysis
offline_analysis
online_fx_jobs
offline_fx_jobs
......@@ -23,7 +23,7 @@ outdir = sys.argv[1]
tocf = open(os.path.join(outdir, "bin.rst"), "w")
tocf.write("""bin
===
=====================
.. toctree::
:maxdepth: 1
......
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