Difference between revisions of "GlueX Doc Efforts, Dec 9, 2021"
From GlueXWiki
(→Links) |
(→Links) |
||
(6 intermediate revisions by 2 users not shown) | |||
Line 12: | Line 12: | ||
== Links == | == Links == | ||
+ | |||
+ | '''New''' [[Software | Software landing page]] for high level overview under construction | ||
* DSelector: [https://halldweb.jlab.org/wiki/index.php/DSelector wiki page] | * DSelector: [https://halldweb.jlab.org/wiki/index.php/DSelector wiki page] | ||
* DSelector: [https://www.overleaf.com/project/5ca37385d3a0d471b3c1a430 Documentation in Overleaf] | * DSelector: [https://www.overleaf.com/project/5ca37385d3a0d471b3c1a430 Documentation in Overleaf] | ||
* GlueX Basics: [https://www.overleaf.com/9649723516hgfwhsnwdjvw GlueX analysis steps] | * GlueX Basics: [https://www.overleaf.com/9649723516hgfwhsnwdjvw GlueX analysis steps] | ||
* Doxygen: [https://www.jlab.org/Hall-D/software/HDSoftware_Documentation/ halld_recon] | * Doxygen: [https://www.jlab.org/Hall-D/software/HDSoftware_Documentation/ halld_recon] | ||
+ | * Doxygen: halld_sim, hooks exist but not much of actual comments in code if any. | ||
+ | * Wiki: [https://halldweb.jlab.org/wiki/index.php/GlueX_Offline_FAQ FAQ], [https://halldweb.jlab.org/wiki/index.php/Offline_HOWTO_List HowTo], [https://halldweb.jlab.org/wiki/index.php/GlueX_Offline_Software#Software_Documentation Software Documentation], .... | ||
== Agenda == | == Agenda == | ||
Line 25: | Line 29: | ||
* Identify Tasks | * Identify Tasks | ||
** Code( e.g. Detector library data objects, and more), Packages | ** Code( e.g. Detector library data objects, and more), Packages | ||
+ | *** example use of doxygen command "\defgroup and \addtogroup" | ||
** Code/Packages usage | ** Code/Packages usage | ||
** Analysis basic concepts and steps | ** Analysis basic concepts and steps |
Latest revision as of 11:27, 16 December 2021
GlueX Documentation Efforts First meeting Dec 9, 2021
Connecting
- To join via a Web Browser, go to the page [1] https://bluejeans.com/660743227.
- To join via Polycom room system go to the IP Address: 199.48.152.152 (bjn.vc) and enter the meeting ID: 660743227.
- To join via phone, use one of the following numbers and the Conference ID: 660743227.
- US or Canada: +1 408 740 7256 or
- US or Canada: +1 888 240 2560
- More information on connecting to bluejeans is available.
Links
New Software landing page for high level overview under construction
- DSelector: wiki page
- DSelector: Documentation in Overleaf
- GlueX Basics: GlueX analysis steps
- Doxygen: halld_recon
- Doxygen: halld_sim, hooks exist but not much of actual comments in code if any.
- Wiki: FAQ, HowTo, Software Documentation, ....
Agenda
- Structure:
- Define first point of contact on wiki
- issue: try to find the link of this wiki page without having this link in the first place!
- Define/understand usage, who is the consumer, ....
- Define hierarchy
- Define first point of contact on wiki
- Identify Tasks
- Code( e.g. Detector library data objects, and more), Packages
- example use of doxygen command "\defgroup and \addtogroup"
- Code/Packages usage
- Analysis basic concepts and steps
- Code( e.g. Detector library data objects, and more), Packages
- Assign priories
- Identify immediate needs
- Identify man power to tackle tasks