README

I. Quick start

• Ressources
  • ROOT: CLUMPY is based on the ROOT CERN package, so the first thing to do is to install it. We refer the user to the ROOT installation help pages for any issue encountered at this stage.
  • Doxygen: if you want to re-generate this doc locally (rather than browsing it online), you need to install Doxygen.
• Installation
  Once ROOT is installed, untar the .tar.gz CLUMPY version you get from the web, and just type make in the main directory.
• Executable
  Type ./bin/clumpy to access all CLUMPY options (fed by command line parameters)
• Examples
  Command lines and expected plots/results for CLUMPY are given here

II. Content of the CLUMPY package

• Directories
  • bin/            exec files (generated by the make command)
  • data/          CLUMPY parameter file + user-defined lists of halos
  • html/          html documentation (generated by Doxygen)
  • include/     .h files
  • latex/         latex documentation (generated by Doxygen)
  • lib/            library libclumpy.a for this package (generated by make)
  • obj/            .o files (generated by make)
  • src/            .cc files
  • DocImages/   images used by the documentation
• Files
  • clumpy_params.txt (user-defined CLUMPY parameters)
  • data/list_generic.txt (list of halos)
  • data/stat_dummy.txt (single halo 'statistical file')
  • Doxyfile (Doxygen parameter file)
  • Makefile (rules to compile)
  • README (roughly the content of this html page)