Commit a8e7f2b6 authored by Ryan Everett's avatar Ryan Everett

Update documentation of reviewd programs.

A new table contains a link to a diff between the current HEAD of master
and the git hash at the time of review.
parent e809cfd4
......@@ -75,6 +75,10 @@ from gstlal import chirptime
# | ------------------------------------------- | ------------------------------------------- | ---------- |
# | Florent, Sathya, Duncan Me., Jolien, Kipp, Chad | 7536db9d496be9a014559f4e273e1e856047bf71 | 2014-04-28 |
#
# | Review Hash | Diff |
# | ---------------------------------------- | ------------------- |
# | 7536db9d496be9a014559f4e273e1e856047bf71 | <a href="@gstlal_inspiral_cgit_diff/bin/gstlal_bank_splitter?id=HEAD&id2=7536db9d496be9a014559f4e273e1e856047bf71">gstlal_bank_splitter</a> |
#
# #### Action
#
# - Consider cleanup once additional bank programs are used and perhaps have additional metadata
......
......@@ -160,6 +160,10 @@
# | ------------------------------------------- | ------------------------------------------- | ---------- |
# | Florent, Sathya, Duncan Me, Jolien, Kipp, Chad | 7536db9d496be9a014559f4e273e1e856047bf71 | 2014-05-02 |
#
# | Review Hash | Diff |
# | ---------------------------------------- | ------------------- |
# | 7536db9d496be9a014559f4e273e1e856047bf71 | <a href="@gstlal_inspiral_cgit_diff/bin/gstlal_inspiral?id=HEAD&id2=7536db9d496be9a014559f4e273e1e856047bf71">gstlal_inspiral</a> |
#
# #### Actions
#
# - Consider cleaning up the nxydump segment option. Currently it only works with modifying source code
......
......@@ -32,6 +32,10 @@
# | ------------------------------------------- | ------------------------------------------- | ---------- |
# | Florent, Jolien, Kipp, Chad | ca54624dac65388bc8dfd0d8f5ed5d187fbcb99a | 2015-05-14 |
#
# | Review Hash | Diff |
# | ---------------------------------------- | ------------------- |
# | ca54624dac65388bc8dfd0d8f5ed5d187fbcb99a | <a href="@gstlal_inspiral_cgit_diff/bin/gstlal_inspiral_marginalize_likelihood?id=HEAD&id2=ca54624dac65388bc8dfd0d8f5ed5d187fbcb99a">gstlal_inspiral_marginalize_likelihood</a> |
#
# #### Action
# - none
#
......
......@@ -97,6 +97,9 @@ from gstlal import far
# | ----------------------------------- | --------------------- | ------------- |
# | Florent, Duncan Me., Jolien, Kipp, Chad | 004cf84d7e980eca0c7fd228c6d49cad959649c7 | 2014-04-29 |
#
# | Review Hash | Diff |
# | ---------------------------------------- | ------------------- |
# | 004cf84d7e980eca0c7fd228c6d49cad959649c7 | <a href="@gstlal_inspiral_cgit_diff/bin/gstlal_inspiral_svd_bank_pipe?id=HEAD&id2=004cf84d7e980eca0c7fd228c6d49cad959649c7">gstlal_inspiral_svd_bank_pipe</a> |
def parse_command_line():
parser = OptionParser()
......
......@@ -22,6 +22,10 @@
# | ------------------------------------------- | ------------------------------------------- | ---------- |
# | Florent, Jolien, Kipp, Chad | 8aad48d2d796642a2925c7d70dd207c06c0e9a70 | 2015-05-14 |
#
# | Review Hash | Diff |
# | ---------------------------------------- | ------------------- |
# | 8aad48d2d796642a2925c7d70dd207c06c0e9a70 | <a href="@gstlal_inspiral_cgit_diff/bin/gstlal_ll_inspiral_get_urls?id=HEAD&id2=8aad48d2d796642a2925c7d70dd207c06c0e9a70">gstlal_ll_inspiral_get_urls</a> |
#
# #### Action
# - none
......
......@@ -80,6 +80,10 @@ from gstlal.far import ThincaCoincParamsDistributions
# | ------------------------------------------- | ------------------------------------------- | ---------- |
# | Florent, Sathya, Duncan Me., Jolien, Kipp, Chad | 7536db9d496be9a014559f4e273e1e856047bf71 | 2014-04-30 |
#
# | Review Hash | Diff |
# | ---------------------------------------- | ------------------- |
# | 7536db9d496be9a014559f4e273e1e856047bf71 | <a href="@gstlal_inspiral_cgit_diff/bin/gstlal_svd_bank?id=HEAD&id2=7536db9d496be9a014559f4e273e1e856047bf71">gstlal_svd_bank</a> |
#
# #### Actions
#
# - Add process params to output
......
......@@ -198,7 +198,7 @@ TAB_SIZE = 4
# will result in a user-defined paragraph with heading "Side Effects:".
# You can put \n's in the value part of an alias to insert newlines.
ALIASES = gstlaldoc=../../gstlal-@GSTLAL_VERSION@/html gstlalinspiralgtkdoc=../../../gtk-doc/html/@PACKAGE_NAME@-@PACKAGE_VERSION@/ gstpluginsgooddoc=http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-good-plugins/html/ gstdoc=http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-plugins/html/ gstpluginsbasedoc=http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-plugins/html/ gstpluginsbaddoc=http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-bad-plugins/html/ cgit=http://www.lsc-group.phys.uwm.edu/cgit/gstlal/plain/gstlal/ reviewed="\htmlonly &#x2713; \endhtmlonly: YES" notreviewed="\htmlonly &#x2717; \endhtmlonly: NO" stable="\image html go.png" moddev="\image html yellow.png" hidev="\image html stop.png"
ALIASES = gstlaldoc=../../gstlal-@GSTLAL_VERSION@/html gstlalinspiralgtkdoc=../../../gtk-doc/html/@PACKAGE_NAME@-@PACKAGE_VERSION@/ gstpluginsgooddoc=http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-good-plugins/html/ gstdoc=http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-plugins/html/ gstpluginsbasedoc=http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-plugins/html/ gstpluginsbaddoc=http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-bad-plugins/html/ cgit=http://www.lsc-group.phys.uwm.edu/cgit/gstlal/plain/gstlal/ reviewed="\htmlonly &#x2713; \endhtmlonly: YES" notreviewed="\htmlonly &#x2717; \endhtmlonly: NO" stable="\image html go.png" moddev="\image html yellow.png" hidev="\image html stop.png" gstlal_inspiral_cgit_diff=https://ligo-vcs.phys.uwm.edu/cgit/gstlal/diff/gstlal-inspiral/
# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding
......
......@@ -26,6 +26,10 @@
# | Florent, Sathya, Duncan Me, Jolien, Kipp, Chad | 7536db9d496be9a014559f4e273e1e856047bf71 | 2014-04-30 |
# | Florent, Surabhi, Tjonnie, Kent, Jolien, Kipp, Chad | 0d7301a22ad3346f1283d3a1917b67aa7ec1c1ab | 2015-05-12 |
#
# | Review Hash | Diff |
# | ---------------------------------------- | ------------------- |
# | 0d7301a22ad3346f1283d3a1917b67aa7ec1c1ab | <a href="@gstlal_inspiral_cgit_diff/python/cbc_template_fir.py?id=HEAD&id2=0d7301a22ad3346f1283d3a1917b67aa7ec1c1ab">cbc_template_fir.py</a> |
#
# #### Action items
#
# - Consider changing the order of interpolation and smoothing the PSD
......
......@@ -26,6 +26,10 @@
# | ------------------------------------------- | ------------------------------------------- | ---------- |
# | Hanna, Cannon, Meacher, Creighton J, Robinet, Sathyaprakash, Messick, Dent, Blackburn | 7fb5f008afa337a33a72e182d455fdd74aa7aa7a | 2014-11-05 |
#
# | Review Hash | Diff |
# | ---------------------------------------- | ------------------- |
# | 7fb5f008afa337a33a72e182d455fdd74aa7aa7a | <a href="@gstlal_inspiral_cgit_diff/python/far.py?id=HEAD&id2=7fb5f008afa337a33a72e182d455fdd74aa7aa7a">far.py</a> |
#
# #### Action items
#
......
......@@ -26,6 +26,10 @@
# | ------------------------------------------- | ------------------------------------------- | ---------- |
# | Kipp Cannon, Chad Hanna, Jolien Creighton, Florent Robinet, B. Sathyaprakash, Duncan Meacher, T.G.G. Li | b8fef70a6bafa52e3e120a495ad0db22007caa20 | 2014-12-03 |
#
# | Review Hash | Diff |
# | ---------------------------------------- | ------------------- |
# | b8fef70a6bafa52e3e120a495ad0db22007caa20 | <a href="@gstlal_inspiral_cgit_diff/python/inspiral.py?id=HEAD&id2=b8fef70a6bafa52e3e120a495ad0db22007caa20">inspiral.py</a> |
#
# #### Action items
# - Document examples of how to get SNR history, etc., to a web browser in an offline search
# - Long term goal: Using template duration (rather than chirp mass) should load balance the pipeline and improve statistics
......
......@@ -31,6 +31,10 @@
# | ------------------------------------------- | ------------------------------------------- | ---------- |
# | Florent, Sathya, Duncan Me, Jolien, Kipp, Chad | 8a6ea41398be79c00bdc27456ddeb1b590b0f68e | 2014-06-18 |
#
# | Review Hash | Diff |
# | ---------------------------------------- | ------------------- |
# | 8a6ea41398be79c00bdc27456ddeb1b590b0f68e | <a href="@gstlal_inspiral_cgit_diff/python/inspiral_pipe.py?id=HEAD&id2=8a6ea41398be79c00bdc27456ddeb1b590b0f68e">inspiral_pipe.py</a> |
#
# #### Actions
#
# - In inspiral_pipe.py Fix the InsiralJob.___init___: fix the arguments
......
......@@ -28,6 +28,10 @@
# | ------------------------------------------- | ------------------------------------------- | ---------- |
# | Sathya, Duncan Me, Jolien, Kipp, Chad | 4bb3204b4ea43e4508dc279ddcfc417366c72841 | 2014-05-02 |
#
# | Review Hash | Diff |
# | ---------------------------------------- | ------------------- |
# | 4bb3204b4ea43e4508dc279ddcfc417366c72841 | <a href="@gstlal_inspiral_cgit_diff/python/lloidparts.py?id=HEAD&id2=4bb3204b4ea43e4508dc279ddcfc417366c72841">lloidparts.py</a> |
#
# #### Actions
# - Feature request: do checkpointing when instruments are down
# - Feature request: need to hook up equivalent of "CAT 2" vetoes to online analysis when ready, and HW inj veto, etc.
......
......@@ -25,6 +25,10 @@
# | ------------------------------------------- | ------------------------------------------- | ---------- |
# | Kipp Cannon, Chad Hanna, Jolien Creighton, Florent Robinet, B. Sathyaprakash, Duncan Meacher, T.G.G. Li | b8fef70a6bafa52e3e120a495ad0db22007caa20 | 2014-12-03 |
#
# | Review Hash | Diff |
# | ---------------------------------------- | ------------------- |
# | b8fef70a6bafa52e3e120a495ad0db22007caa20 | <a href="@gstlal_inspiral_cgit_diff/python/streamthinca.py?id=HEAD&id2=b8fef70a6bafa52e3e120a495ad0db22007caa20">streamthinca.py</a> |
#
# #### Action items
#
# - L300+: Please document within the code that the FAR column is used to store FAP so that future developers don't get confused what that column represents
......
......@@ -24,6 +24,10 @@
# | ------------------------------------------- | ------------------------------------------- | ---------- |
# | Florent, Sathya, Duncan Me, Jolien, Kipp, Chad | 7536db9d496be9a014559f4e273e1e856047bf71 | 2014-04-30 |
#
# | Review Hash | Diff |
# | ---------------------------------------- | ------------------- |
# | 7536db9d496be9a014559f4e273e1e856047bf71 | <a href="@gstlal_inspiral_cgit_diff/python/svd_bank.py?id=HEAD&id2=7536db9d496be9a014559f4e273e1e856047bf71">svd_bank.py</a> |
#
# #### Actions
# - Consider a study of how to supply the svd / time slice boundaries
#
......
......@@ -23,6 +23,10 @@
# | ------------------------------------------- | ------------------------------------------- | ---------- |
# | Florent, Sathya, Duncan Me, Jolien, Kipp, Chad | 7536db9d496be9a014559f4e273e1e856047bf71 | 2014-04-29 |
#
# | Review Hash | Diff |
# | ---------------------------------------- | ------------------- |
# | 7536db9d496be9a014559f4e273e1e856047bf71 | <a href="@gstlal_inspiral_cgit_diff/python/templates.py?id=HEAD&id2=7536db9d496be9a014559f4e273e1e856047bf71">templates.py</a> |
#
# #### Actions
#
# - Performance of time slices could be improved by e.g., not using powers of 2 for time slice sample size. This might also simplify the code
......
......@@ -61,6 +61,9 @@ from optparse import OptionParser
# | ----------------------------------- | --------------------- | ------------- |
# | Florent, Duncan Me., Jolien, Kipp, Chad |abedb7c19ad3d5348c000bc5f9435d5d2e810e42 | 2014-04-29 |
#
# | Review Hash | Diff |
# | ---------------------------------------- | ------------------- |
# | abedb7c19ad3d5348c000bc5f9435d5d2e810e42 | <a href="@gstlal_cgit_diff/bin/gstlal_psd_xml_from_asd_txt?id=HEAD&id2=abedb7c19ad3d5348c000bc5f9435d5d2e810e42">gstlal_psd_xml_from_asd_txt</a> |
#
parser = OptionParser(description = __doc__)
......
......@@ -197,7 +197,7 @@ TAB_SIZE = 4
# will result in a user-defined paragraph with heading "Side Effects:".
# You can put \n's in the value part of an alias to insert newlines.
ALIASES = gstlalgtkdoc=../../../gtk-doc/html/@PACKAGE_NAME@-@PACKAGE_VERSION@/ gstpluginsgooddoc=http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-good-plugins/html/ gstdoc=http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-plugins/html/ gstpluginsbasedoc=http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-plugins/html/ gstpluginsbaddoc=http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-bad-plugins/html/ cgit=http://www.lsc-group.phys.uwm.edu/cgit/gstlal/plain/gstlal/ reviewed="\htmlonly &#x2713; \endhtmlonly: YES" notreviewed="\htmlonly &#x2717; \endhtmlonly: NO" stable="\image html go.png" moddev="\image html yellow.png" hidev="\image html stop.png"
ALIASES = gstlalgtkdoc=../../../gtk-doc/html/@PACKAGE_NAME@-@PACKAGE_VERSION@/ gstpluginsgooddoc=http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-good-plugins/html/ gstdoc=http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-plugins/html/ gstpluginsbasedoc=http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-plugins/html/ gstpluginsbaddoc=http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-bad-plugins/html/ cgit=http://www.lsc-group.phys.uwm.edu/cgit/gstlal/plain/gstlal/ reviewed="\htmlonly &#x2713; \endhtmlonly: YES" notreviewed="\htmlonly &#x2717; \endhtmlonly: NO" stable="\image html go.png" moddev="\image html yellow.png" hidev="\image html stop.png" gstlal_cgit_diff=https://ligo-vcs.phys.uwm.edu/cgit/gstlal/diff/gstlal/
# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding
......
......@@ -34,6 +34,10 @@
# | ------------------------------------------- | ------------------------------------------- | ---------- |
# | Florent, Sathya, Duncan Me., Jolien, Kipp, Chad | b3ef077fe87b597578000f140e4aa780f3a227aa | 2014-05-01 |
#
# | Review Hash | Diff |
# | ---------------------------------------- | ------------------- |
# | b3ef077fe87b597578000f140e4aa780f3a227aa | <a href="@gstlal_cgit_diff/python/datasource.py?id=HEAD&id2=b3ef077fe87b597578000f140e4aa780f3a227aa">datasource.py</a> |
#
# #### Action items
#
# - State vector, DQ, etc must be in place by November and should be coordinated with JRPC/DAC/DetChar/CBC/etc
......
......@@ -53,6 +53,11 @@ from gstlal import datasource
# | ------------------------------------------- | ------------------------------------------- | ---------- |
# | Florent, Sathya, Duncan Me, Jolien, Kipp, Chad | 8a6ea41398be79c00bdc27456ddeb1b590b0f68e | 2014-06-18 |
#
#
# | Review Hash | Diff |
# | ---------------------------------------- | ------------------- |
# | 8a6ea41398be79c00bdc27456ddeb1b590b0f68e | <a href="@gstlal_cgit_diff/python/multirate_datasource.py?id=HEAD&id2=8a6ea41398be79c00bdc27456ddeb1b590b0f68e">multirate_datasource.py</a> |
# #### Actions
#
# - Is the h(t) gate really necessary? It shouldn't really be used unless
......
......@@ -67,6 +67,9 @@ from gstlal import simplehandler
# | ------------------------------------------- | ------------------------------------------- | ---------- |
# | Florent, Sathya, Duncan Me., Jolien, Kipp, Chad | b3ef077fe87b597578000f140e4aa780f3a227aa | 2014-05-01 |
#
# | Review Hash | Diff |
# | ---------------------------------------- | ------------------- |
# | b3ef077fe87b597578000f140e4aa780f3a227aa | <a href="@gstlal_cgit_diff/python/reference_psd.py?id=HEAD&id2=b3ef077fe87b597578000f140e4aa780f3a227aa">reference_psd.py</a> |
#
# #### Action items
#
......
......@@ -47,6 +47,10 @@ import signal
# | ------------------------------------------- | ------------------------------------------- | ---------- |
# | Florent, Sathya, Duncan Me., Jolien, Kipp, Chad | b3ef077fe87b597578000f140e4aa780f3a227aa | 2014-05-01 |
#
# | Review Hash | Diff |
# | ---------------------------------------- | ------------------- |
# | b3ef077fe87b597578000f140e4aa780f3a227aa | <a href="@gstlal_cgit_diff/python/simplehandler.py?id=HEAD&id2=b3ef077fe87b597578000f140e4aa780f3a227aa">simplehandler.py</a> |
# #### Action items
#
# - Get event based programming expert to have a look?
......
......@@ -34,6 +34,11 @@ from pylal.datatypes import LIGOTimeGPS
# | ------------------------------------------- | ------------------------------------------- | ---------- |
# | Sathya, Duncan Me, Jolien, Kipp, Chad | 7536db9d496be9a014559f4e273e1e856047bf71 | 2014-05-02 |
#
#
# | Review Hash | Diff |
# | ---------------------------------------- | ------------------- |
# | 7536db9d496be9a014559f4e273e1e856047bf71 | <a href="@gstlal_cgit_diff/python/simulation.py?id=HEAD&id2=7536db9d496be9a014559f4e273e1e856047bf71">simulation.py</a> |
#
## @package python.simulation
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment