Skip to content
This repository has been archived by the owner on Dec 7, 2018. It is now read-only.

Commit

Permalink
update workflow doc (#46)
Browse files Browse the repository at this point in the history
* update workflow doc

* add run_gwin

* change default values

I found I had to change the
time window to be larger
and also reduced the length
of time from 2048s to 1048s
as this was perhaps a bit excessive
  • Loading branch information
Cyberface authored and Collin Capano committed Jul 18, 2018
1 parent b642299 commit 85bdf53
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/command-line/gwin_make_inj_workflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ A simple workflow configuration file::
[executables]
; paths to executables to use in workflow
create_injections = ${which:pycbc_create_injections}
inference = ${which:gwin}
inference = ${which:run_gwin}
inference_intervals = ${which:gwin_plot_inj_intervals}
inference_posterior = ${which:gwin_plot_posterior}
inference_rate = ${which:gwin_plot_acceptance_rate}
Expand Down
22 changes: 11 additions & 11 deletions docs/command-line/gwin_make_workflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,12 @@ A simple workflow configuration file::

[executables]
; paths to executables to use in workflow
inference = ${which:pycbc_inference}
inference_posterior = ${which:pycbc_inference_plot_posterior}
inference_prior = ${which:pycbc_inference_plot_prior}
inference_rate = ${which:pycbc_inference_plot_acceptance_rate}
inference_samples = ${which:pycbc_inference_plot_samples}
inference_table = ${which:pycbc_inference_table_summary}
inference = ${which:run_gwin}
inference_posterior = ${which:gwin_plot_posterior}
inference_prior = ${which:gwin_plot_prior}
inference_rate = ${which:gwin_plot_acceptance_rate}
inference_samples = ${which:gwin_plot_samples}
inference_table = ${which:gwin_table_summary}
plot_spectrum = ${which:pycbc_plot_psd_file}
results_page = ${which:pycbc_make_html_page}

Expand Down Expand Up @@ -113,7 +113,7 @@ A simple workflow configuration file::
Inference configuration file
============================

You will also need a configuration file with sections that tells ``pycbc_inference`` how to construct the priors. A simple inference configuration file is::
You will also need a configuration file with sections that tells ``gwin`` how to construct the priors. A simple inference configuration file is::

[model]
name = gaussian_noise
Expand Down Expand Up @@ -281,19 +281,19 @@ Else you can run from a specific GPS end time with the ``--gps-end-time`` option
--output-file ${WORKFLOW_NAME}.dax \
--output-map ${OUTPUT_MAP_PATH} \
--gps-end-time ${GPS_END_TIME} \
--config-overrides workflow:start-time:$((${GPS_END_TIME}-2)) \
workflow:end-time:$((${GPS_END_TIME}+2)) \
--config-overrides workflow:start-time:$((${GPS_END_TIME}-16)) \
workflow:end-time:$((${GPS_END_TIME}+16)) \
workflow-inference:data-seconds-before-trigger:2 \
workflow-inference:data-seconds-after-trigger:2 \
inference:psd-start-time:$((${GPS_END_TIME}-300)) \
inference:psd-end-time:$((${GPS_END_TIME}+1748)) \
inference:psd-end-time:$((${GPS_END_TIME}+748)) \
results_page:output-path:${HTML_DIR} \
results_page:analysis-subtitle:${WORKFLOW_NAME}


Where ``${GPS_END_TIME}`` is the GPS end time of the trigger.

For the CBC example above define the environment variables ``GPS_END_TIME=1126259462`` and ``OUTPUT_MAP_PATH=output.map``.
For the CBC example above define the environment variables ``GPS_END_TIME=1126259462`` and ``OUTPUT_MAP_PATH=output.map``.

=============================
Plan and execute the workflow
Expand Down

0 comments on commit 85bdf53

Please sign in to comment.