cp2k-syntax

为Sublime Text 3中对CP2K输入文件的全面语法高亮显示。

CP2K是一个免费程序包，用于对固态、液体、分子、周期性、材料、晶体和生物系统进行原子模拟。

示例图中的配色方案为base16-railscasts

特色功能

• 基于.sublime-syntax格式的语法高亮显示，需要Sublime Text 3的最新版本（至少构建编号3084）
• 独立的Python代码检查器，它解析输入文件并将其与CP2K的XML输入描述进行比较
• 常用控制序列的代码片段

安装

安装该软件包的最简单方法是使用Package Control。此外，您还可以克隆此存储库。

通过Package Control安装

1. 请确保您有一个有效的Python解释器（支持的版本=>2.5和3.x）。
2. 如果尚未安装，请为Sublime Text 3安装Package Control。
3. 安装SublimeLinter。
4. 通过Package Control安装此软件包
   1. 打开命令面板（在Linux/Windows上为ctrl+shift+p）
   2. 键入install并选择Package Control: Install Package
   3. 键入cp2k并选择cp2k-syntax

通过Git安装

1. 请确保您已安装上述所有先决条件。
2. 在终端中打开并创建此存储库的工作目录。
3. 移动到上一步骤中创建的目录并克隆存储库git clone https://github.com/nholmber/cp2k-syntax
4. 在本地Sublime Text的Packages/User目录（请参阅查找目录说明）中为该软件包创建一个文件夹。
5. 递归地复制（cp -r *）与该软件包相关的所有文件到我之前创建的文件夹中。

使用和配置

默认情况下，以.inp、.inc和.restart结尾的文件被视为CP2K输入文件，并且应该自动对这些文件应用语法高亮显示。如果自动检测没有工作或您希望为不同的文件扩展名启用高亮显示，您需要采取以下步骤

1. 打开您希望启用语法高亮的文件。
2. 转到查看 -> 语法 -> 将当前扩展名的一切作为 ... -> CP2K 输入

通过SublimeLinter软件包，解析并显示在屏幕上的linter输出。若要自定义linting视图和其他设置，请参阅SublimeLinter的文档。

linter通过解析CP2K的XML输入描述来识别允许的关键字名称。为CP2K版本3.0提供了一个示例XML文件sample-xml/cp2k_input.xml，并且linter默认使用此文件。如果您使用的是不同的CP2K版本，可以通过以下步骤用您的文件替换默认的XML文件

1. 为您版本的CP2K创建XML输入描述。
2. 将生成的cp2k_input.xml放入任何目录。
3. 配置linter使用生成的文件。
   1. 打开命令面板（在Linux/Windows上为ctrl+shift+p）
   2. 输入preferences sub并选择首选项: SublimeLinter 设置 -- 用户
   3. 在设置中向下滚动，找到cp2klint设置（在linters下）。
   4. 将默认的manualfile替换为您自己的XML文件，包括文件的完整路径和文件名。

贡献

如果您在linter或语法高亮显示中发现了错误，请在新问题跟踪器中新建一个问题，并包含一个用于复现错误的文件的最小输入文件。您也可以通过fork项目并提交一个pull request来直接进行贡献。请查阅问题跟踪器查找已知问题和需要实现的功能。