Folder structure in the CombLayer repository

  • Documents
  • Main
  • Model
    • Model (geometry) files
    • The PIK-related classes are defined in Model/pikInc and implemented in Model/pik
    • Avoid modifying any files which live outside these folders. If you do it, make a pool request into the master branch in a separate commit.
  • NonCompiledProjects
    • Collection of old models which need to be fixed in order to be compiled with the current CombLayer version.
    • This is because the CombLayer syntax evolves with time and we did not have time to look at these projects and update them.
  • System
  • src and include
    • CombLayer core classes.
    • Do not touch them unless you know what you are doing.
  • beamline and beamlineInc
    • base beamline-related classes
  • global and globalInc
    • XMLwriteVisitor - base class for XML output
    • BaseVisit and BaseModVisit - base visitation-related classes
    • I believe eventually these files should be moved into src and System
  • instrument and instrumentInc
    • original beamline-related classes
    • I believe they should go to beamline
  • povray
  • scatMat and scatMatInc
    • some material definitions to model neutron scattering within CombLayer
  • specialInc
    • divideManager - a legacy class to split cells by layers
  • test and testInclude
    • unit tests
  • transport and transportInc
    • files related with neutron transport calculations within CombLayer
  • Obsolete scripts (not used anymore):
    • CMake.pl
      • Perl script which generates cmake list file, CMakeLists.txt
    • CMakeList.pm and CMakeSupport.pm
  • Doxyfile
    • doxygen config file
    • make doxygen generates class reference (open html/index.html)
  • getMk.pl
    • legacy build system (replaced with CMake.pl)
    • an old way to build CombLayer - do not use it
  • getMake.pm
    • perl module for getMk.pl (legacy)