Metaproject documentation

• The offline-software metaproject
  • Projects that need docs
  • Overview
  • Getting Started - A guided tour

Components of this metaproject

• DOMcalibrator documentataion
• I3Db documentation
• Amanda-core Documentation
• CMake: icetray’s build system
  • User’s Guide
  • Organization/Structure of Projects and Metaprojects
  • Documentation
  • Targets
  • Building tarballs for use on clusters or the grid
  • Tool detection/configuration
  • I3Test Reference
  • Icetray-specific cmake macro reference
  • How to write pybindings for your project
  • DarwinPorts
  • Details by Platform
  • Introduction to Subversion for use with IceTray
  • env-shell.sh
  • .mailinglist: Commit Emails
  • Using the Intel C++ compiler
  • gfilt, the C++ error message descrambler
  • Information on particular tools
• Coordinate-service Documentation
• Daq-decode Documentation
• Dataclasses documentation
  • I3Particle
  • Python bindings to dataclasses
  • FAQ / common errors
  • icecube.dataclasses – python bindings to dataclasses
• Dataio
  • IceTray I/O
  • Making a class serializable
  • Using the I3Muxer
  • icecube.dataio – python bindings to Data I/O utilities
  • Changes
• Examples
  • I3Modules
  • Services
  • Scripts
• Filter-tools Documentation
• GLShovel
  • Needed tools
  • Using the GLShovel
  • Setting up the I3TV server
  • Tips for making movies with the GLShovel
  • COMMON TROUBLES
  • NEWS
  • Compiling the I3TVTPD
• Icepick Documentation
• Icetray
  • Icetray classes
  • Logging
  • “Frame Stream Stop”
  • icetray-inspect
  • Standard I3Modules supplied with IceTray
  • Python scripting in IceTray
  • NaN and Inf
  • Using I3Units
  • New in v3
  • Version 3
  • I3Tray – icetray convenience interface
  • icecube.icetray – icetray
  • To Document
• Interfaces Documentation
• Jebclasses Documentation
• Payload-Parsing Documentation
• Phys-Services Documentation
• Twr-Decode Documentation
• TWRClasses Documentation
• icecube.util – icecube python utilities
  • functions
  • modules

Of general interest

• svn information
  • externals
• IceCube C++ Coding Standards
  • Introduction
  • C++ Coding Standards
  • Organizational and Policy Issues
  • Coding Style
  • Functions and Operators
  • STL: Containers
  • Useful links
• Effective mailng-list communication
  • State your problem clearly.
  • Isolate the problem.
  • Avoid authoritative tone when misdiagnosing a problem
  • Be very specific when reporting error messages.
  • If you know the answer to someone else’s question, answer it
  • Please don’t email your questions directly to ‘experts’
  • Google your error messages.
  • Try it out.
  • Use an illustrative subject line.
  • If you’ve struggled with a useless/vague error message, don’t let the problem state slip away
  • If you have a compile / build problem, include verbose make output
• How to run a python script under the debugger
  • Dealing with log_fatal() calls
  • Profiling C++ Code

Automatically Generated Documentation

Doxygen

Icetray-inspect

About this documentation

See Documentation