Metaproject documentation

• The icerec meta-project
  • IceRec projects
  • Dependencies

Components of this metaproject

• 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
• Icetray
  • Icetray classes
  • Logging
  • icetray-inspect
  • Standard I3Modules supplied with IceTray
  • Python scripting in IceTray
  • NaN and Inf
  • Using I3Units
  • New in v3
  • New In v4
  • I3Tray – icetray convenience interface
  • icecube.icetray – icetray
  • To Document
• Dataio
  • IceTray I/O
  • Making a class serializable
  • icecube.dataio – python bindings to Data I/O utilities
  • Changes
• Dataclasses documentation
  • I3Particle
  • Python bindings to dataclasses
  • FAQ / common errors
  • icecube.dataclasses – python bindings to dataclasses
• VHESelfVeto
• WaveCalibrator
  • I3WaveCalibrator
  • I3WaveformSplitter
  • I3WaveformTimeRangeCalculator
• Daq-decode Documentation
• Examples
  • I3Modules
  • Services
  • Scripts
• hdfwriter
  • Usage
  • Reading with pytables
  • Using the built-in HDF5 libraries on your system
• Interfaces Documentation
• Millipede
  • Common Options
  • Cast of Characters
  • How it Works
• Payload-Parsing Documentation
• Photonics-service Documentation
  • Usage
  • Internals
  • Additional Reading
• Photospline
  • Fitting tutorial
  • Python library reference
  • C library reference
• Phys-Services Documentation
• rootwriter
  • Usage
  • Automatic file splitting
• tableio
  • Rationale
  • Design
• topeventcleaning
  • I3HLCTankPulseMerger
  • I3TopHLCClusterCleaning
  • KeepOnlyLargestEvent
• tpx
  • I3IceTopSanityChecks
  • I3TopHLCPulseExtractor
  • I3TopSLCPulseExtractor
  • I3IceTopBaselineModule
  • I3VEMConverter
  • Classes
• wavedeform
  • Arguments
• wavereform
  • Modules
• Weighting
  • Introduction
  • Tutorial
  • Event generator details
  • API

Of general interest

• Svn information for this metaproject
  • externals
• IceCube C++ Coding Standards
  • Introduction
  • Python Coding Standards
  • C++ Coding Standards
  • Organizational and Policy Issues
  • Coding Style
  • Functions and Operators
  • STL: Containers
  • Useful links
• Library Standards
  • Introduction
  • Maintained
  • Open Source
  • Documented
  • Strong User Base
  • Ease Of Working With Developers
  • Portability
  • Code Quality
• Effective mailing-list communication
  • Don’t “top-post”
  • Please don’t email your questions directly to ‘experts’
  • State your problem clearly.
  • Isolate the problem.
  • Be very specific when reporting error messages.
  • If you know the answer to someone else’s question, answer it
  • Avoid authoritative tone when misdiagnosing a problem
  • Try it out.
  • Use an illustrative subject line.
  • Missing or misleading error messages are bugs!
  • 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
  • State clearly what software you are using
• 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