The Columbia Physics System (CPS)

The core format of this documentation is html, although others will be added shortly. Of course, the content of these documents is expected to evolve heavily over time.

Proposal for a new code structure for the CPS code, here [html] [pdf] [ps] [source]

Core CPS documentation

• install notes 
  Information concerning how to install this software. [html] [pdf] [ps] [source]


• structure
  Explanation of the overall code & build structure, filename extensions etc. [html] [pdf] [ps] [source]


• roadmap
  The overall code development roadmap, indicating current status and future development. [html] [pdf] [ps] [source]


• doxygen
  Documented version of the entire code. [html] [pdf] [ps]


• manual
  General programming manual for using this library. [html] [pdf] [ps] [source]


• testing
  Documentation for the test suite. [html] [pdf] [ps] [source]


• change log
  Notes on the changes and the different versions of the code in the UKQCD repository. [html] [pdf] [ps] [source]

Documentation for particular libraries & platforms

• qcdsp
  Documentation specific to using the CPS on QCDSP. [html] [pdf] [ps] [source]


• qcdio 
  Specification of the QCD Input/Output API. [html] [pdf] [ps] [source]


• mpi-scu
  The MPI implementation of the QCDSP serial communications API.
• General documentation/manual/user guide. [html] [pdf] [ps] [source]
• Documented source code for the MPI-SCU layer, generated using doxygen . [html]

Other online documentation

• cvs access
  How to access the UKQCD QCDOC code repository.


• to do
  The to-do list for this documentation.