Difference between revisions of "Documentation"

From PREX Wiki
Jump to: navigation, search
m (Topic Specific Logbooks)
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
<span style="color:red">In the process of editing and updating this page. Please contact Juliette Mammei <B>[mailto:crowder@jlab.org?Subject=PREXwiki crowder@jlab.org]</B> with questions or suggestions.</span>
 
<span style="color:red">In the process of editing and updating this page. Please contact Juliette Mammei <B>[mailto:crowder@jlab.org?Subject=PREXwiki crowder@jlab.org]</B> with questions or suggestions.</span>
 
<br><br>
 
<br><br>
[https://prex.jlab.org/wiki/index.php/Main_Page <B>PREX Main</B>]
+
[[Main_Page|<B>PREX Main</B>]]
 +
 
 +
For more info about the experiments, see [[PREX-CREX]]
  
 
== Links to various logbooks/docDBs ==
 
== Links to various logbooks/docDBs ==
  
* [https://logbooks.jlab.org/book/halog HALOG] - use this for short, prompt entries and work summaries during running
+
* [https://logbooks.jlab.org/book/halog HALOG] - use this for short, prompt, frequent entries and work summaries during running
 
* "HAPLOG" the PREX/CREX  [https://ace.phys.virginia.edu:80/HAPPEX/ ELOG] - use this for more complete summaries  
 
* "HAPLOG" the PREX/CREX  [https://ace.phys.virginia.edu:80/HAPPEX/ ELOG] - use this for more complete summaries  
 
* DocDB - use this for presentations, technotes, instruction manuals
 
* DocDB - use this for presentations, technotes, instruction manuals
Line 11: Line 13:
 
** [https://prex.jlab.org/cgi-bin/DocDB/public/DocumentDatabase public docDB]
 
** [https://prex.jlab.org/cgi-bin/DocDB/public/DocumentDatabase public docDB]
 
* Wiki (these pages) - for organizing the instructions for running, living documents describing HOW TOs, etc.
 
* Wiki (these pages) - for organizing the instructions for running, living documents describing HOW TOs, etc.
 
+
*  Data tracking, data quality, and analysis results
Note: You can always put links to the DocDB, elog or HAPLOG; you don't necessarily need to re-write things.  Please don't duplicate pages on the wiki; this can lead to confusion if one page is updated and another is not.  Please link to existing pages and update those whenever possible.  
+
** [https://hallaweb.jlab.org/rcdb/ Run Configuration/Conditions Database]:  Allows browsing of the run conditions; this should also contain links into the prompt analysis output as described below.
 +
** [https://hallaweb.jlab.org/parity/prex/onlinePlots/live.php  Panguin Live]:  beam charge asymmetry and position difference plots through the injector, primarily intended for OPS to use to evaluate the impact of tuning on the parity quality of the beam.  The plots update about every 30 seconds or so, but they accumulate a few minutes (so changes are usually gradual).
 +
** [https://hallaweb.jlab.org/parity/prex/onlinePlots/ Prompt analysis output]:  The prompt analysis tool-chain sends plots and text summaries of each run to this directory
 +
* [[Operations]]
 +
Note: You can always put links to the DocDB, elog or HAPLOG; you don't necessarily need to re-write things.  Please don't duplicate pages on the wiki; this can lead to confusion if one page is updated and another is not.  Please link to existing pages and update those whenever possible.
  
 
== Topic Specific Logbooks ==
 
== Topic Specific Logbooks ==
Line 18: Line 24:
 
* DAQ Documentation [[DAQ_Doc_Portal | Portal]]
 
* DAQ Documentation [[DAQ_Doc_Portal | Portal]]
 
* GEM Systems and Hardware [[GEM_Doc_Portal | Portal]]
 
* GEM Systems and Hardware [[GEM_Doc_Portal | Portal]]
 +
* Optics and Counting [[HRS_Analysis|Portal]]
 
* JAPAN Analysis Module [[JAPAN_Doc_Portal | Portal]]  
 
* JAPAN Analysis Module [[JAPAN_Doc_Portal | Portal]]  
 
* Control GUIs [[Control_GUIs_Doc_Portal|Portal]]
 
* Control GUIs [[Control_GUIs_Doc_Portal|Portal]]
 
* Beam Modulation Documentation [[Beam_Mod_Portal | Portal]]
 
* Beam Modulation Documentation [[Beam_Mod_Portal | Portal]]
* Compton [https://hallaweb.jlab.org/dvcslog/compton/ ELOG ]
+
* Compton Documentation [[Compton_Doc_Portal|Portal]], [https://hallaweb.jlab.org/dvcslog/compton/ ELOG ]
 
* Moller Polarimeter ([https://hallaweb.jlab.org/equipment/moller/ hallaweb])
 
* Moller Polarimeter ([https://hallaweb.jlab.org/equipment/moller/ hallaweb])
 
* Green Monster Rework Documentation [[Green_Monster_Doc | Portal]]
 
* Green Monster Rework Documentation [[Green_Monster_Doc | Portal]]
Line 28: Line 35:
 
** [https://prex.jlab.org/wiki/index.php/PREX-CREX-2017ERR ERR 2017] &nbsp; We passed the review.
 
** [https://prex.jlab.org/wiki/index.php/PREX-CREX-2017ERR ERR 2017] &nbsp; We passed the review.
 
** [https://prex.jlab.org/wiki/index.php/PREX-CREX-2016ERR ERR 2016]
 
** [https://prex.jlab.org/wiki/index.php/PREX-CREX-2016ERR ERR 2016]
 
  
 
== Instructions ==
 
== Instructions ==
Line 37: Line 43:
 
** [[JAPAN_Doc_Portal#Example_install_of_Japan_on_ifarm_-_not_in_apar.40adaq3_or_even_for_main_DAQ_data|'''Installing japan outside Counting House Guide''']]
 
** [[JAPAN_Doc_Portal#Example_install_of_Japan_on_ifarm_-_not_in_apar.40adaq3_or_even_for_main_DAQ_data|'''Installing japan outside Counting House Guide''']]
 
** [[CODA_Running_Quickstart|'''CODA Running and Analysis Quickstart''']]
 
** [[CODA_Running_Quickstart|'''CODA Running and Analysis Quickstart''']]
 +
** '''[[Online Plots]]'''
 +
** '''[[Strip Charts]]'''
 
* HRS DAQ and Analysis for Q<sup>2</sup> and Optics
 
* HRS DAQ and Analysis for Q<sup>2</sup> and Optics
 
** [[HRS DAQ|'''HRS DAQ''']]
 
** [[HRS DAQ|'''HRS DAQ''']]
 
** [[Podd Analyzer|'''Podd Analyzer''']]
 
** [[Podd Analyzer|'''Podd Analyzer''']]
 
* [https://hallaweb.jlab.org/parity/prex/howto_DocDB.html HOWTO contribute to docDB]
 
* [https://hallaweb.jlab.org/parity/prex/howto_DocDB.html HOWTO contribute to docDB]
 +
* [[Wiki editing guide]]
 +
 +
[[Category:HOW TO]][[Category:SL]][[Category:TO]][[Category:WAC]]

Latest revision as of 14:39, 29 June 2020

In the process of editing and updating this page. Please contact Juliette Mammei crowder@jlab.org with questions or suggestions.

PREX Main

For more info about the experiments, see PREX-CREX

Links to various logbooks/docDBs

  • HALOG - use this for short, prompt, frequent entries and work summaries during running
  • "HAPLOG" the PREX/CREX ELOG - use this for more complete summaries
  • DocDB - use this for presentations, technotes, instruction manuals
  • Wiki (these pages) - for organizing the instructions for running, living documents describing HOW TOs, etc.
  • Data tracking, data quality, and analysis results
    • Run Configuration/Conditions Database: Allows browsing of the run conditions; this should also contain links into the prompt analysis output as described below.
    • Panguin Live: beam charge asymmetry and position difference plots through the injector, primarily intended for OPS to use to evaluate the impact of tuning on the parity quality of the beam. The plots update about every 30 seconds or so, but they accumulate a few minutes (so changes are usually gradual).
    • Prompt analysis output: The prompt analysis tool-chain sends plots and text summaries of each run to this directory
  • Operations

Note: You can always put links to the DocDB, elog or HAPLOG; you don't necessarily need to re-write things. Please don't duplicate pages on the wiki; this can lead to confusion if one page is updated and another is not. Please link to existing pages and update those whenever possible.

Topic Specific Logbooks

Instructions