This is an old revision of the document!
Packages
The code base is structured into directories. This will allow for making CP2K more modular, i.e. consisting of smaller packages with fewer dependencies. Every directory therefore contains a file named PACKAGE
. A typical PACKAGE
, which uses python syntax, looks like this:
{ "description": "Distributed Block Compressed Sparse Row, A sparse matrix library", "requires": ["../base", "../mpiwrap", "../acc", "libsmm_acc"], "public": ["dbcsr_api.F"], "archive": "libdbcsr", }
The entries description
and requires
are mandatory.
The entry requires
list all the directories on which the code in the current directory may depend upon. This means, modules in the current directory may only use modules from the listed directories. The requirements between directories must not have cycles. This is checked during compilation.
The optional entry public
lists all files, which other packages may use. This allows to hide package internals. If the public
entry is absent, all files within the package are public. This is checked during compilation.
The optional entry archive
allows to overwrite the filename of the archive, which is created during compilation. The default name is “libcp2k<package_name>”.