Analysis Software
Documentation for sPHENIX simulation software
|
Welcome to sPHENIX simulation software documentation!
Many feature of the website will help you navigate through the ocean of PHENIX software. Few are highlighted here:
Through a special build of Doxygen, sPHENIX Git Hub respostory were automatically linked for Files, directories and member definitions. And users can choose between viewing the local copy of the source code (with more features) or the GitHub version (most up-to-date). Check out links like View newest version in sPHENIX GitHub in e.g. PHG4Reco::set_field .
On some computers, user may experience delay up to 10s while loading pages from this web site. This is usually due to that the user browser rebuilds the navigation panel on the left side, which contains the index of thousands of software modules. In that case, to speed up the browsing, users can choose to stop auto-updating of the navigation panel by toggle off the "Sync" switch:
, which is on the left top.
You are highly encouraged to put Doxygen-style comments in your code, which will then be automatically applied to the documentation pages on this website (refreshed from repository every a few hours). These features are easy to use, and helpful for readers to understand and use your developemnt.
To start use the Doxygen-style comments, please read the instruction page on the Doxygen website. Or even more easier, please just take a look at this example, which will show up in Doxygen page like this. You are also welcome to let Jin Huang know, if there is any question or suggestions.
sPHENIX Wiki provides an up-to-date documentation for sPHENIX construction and analyzers.