mdkits 0.1.28__tar.gz → 0.1.30__tar.gz

{mdkits-0.1.28 → mdkits-0.1.30}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mdkits
-Version: 0.1.28
+Version: 0.1.30
 Summary: kits for md or dft
 License: MIT
 Keywords: molecular dynamics,density functional theory
@@ -21,102 +21,144 @@ Requires-Dist: julia (>=0.6.2,<0.7.0)
 Requires-Dist: matplotlib (>=3.9.0,<4.0.0)
 Requires-Dist: numpy (>=1.26.4,<2.0.0)
 Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
+Requires-Dist: tidynamics (>=1.1.2,<2.0.0)
 Project-URL: Repository, https://github.com/jxxcr/mdkits
 Description-Content-Type: text/markdown
 
-# MD 轨迹分析脚本
+# mdkits
 `mdkits` 提供了多种工具, 安装脚本:
 ```bash
 pip install mdkits --upgrade
 ```
+## 通用的选项参数类型
+1. `CELL TYPE`: 指定晶胞参数, 如`10,10,10`, `10,10,10,90,90,90`等
+2. `FRAME RANGE`: 指定帧范围, 如`1`, `1:10:2`等
+3. `--group`和`--surface`: 按[选择语言](https://userguide.mdanalysis.org/stable/selections.html)选取分析对象
+4. `--update_water`, `--distance` 和 `--angle`: 在分析轨迹的过程中开启动态更新水分子的功能
 
+## 轨迹文件处理脚本
+`md`为轨迹文件处理工具, 其中包含多个处理工具
 ### 密度分布
-`density`用于分析体系中的某种元素沿z轴的密度分布, 如分析体系中的`O`元素沿z轴的密度分布, `--element`选项指定元素使用`MDAnalysis`的[选择语言](https://userguide.mdanalysis.org/stable/selections.html):
+`density`用于分析体系中的某种元素沿z轴的密度分布, 如分析体系中的`O`元素沿z轴的密度分布:
 ```bash
-mdkits density [FILENAME] --element="name H" --cell [FILENAME]
+mdkits md density [FILENAME] --group="name H" --cell [FILENAME]
 ```
 这样会输出一个文件名为`density_name_H.dat`的文件, 第一列为z轴坐标, 第二列为浓度分布, 单位为 mol/L. 如果想输出为单位为 $g/cm^3$ 的密度分布, 可以指定`--atomic_mass` 选项, 如:
 ```bash
-mdkits density [FILENAME] --element="name H" --cell [FILENAME] --atomic_mass=1.00784
+mdkits md density [FILENAME] --group="name H" --cell [FILENAME] --atomic_mass=1.00784
 ```
 则输出单位为 $g/cm^3$ 的密度分布. 可以指定表面原子来将密度分布归一化到表面, 如:
 ```bash
-mdkits density [FILENAME] --element="name O" --cell 10,10,10 --atomic_mass=18.01528 --surface="name Pt and name Ru"
+mdkits md density [FILENAME] --group="name O" --cell 10,10,10 --atomic_mass=18.01528 --surface="name Pt and name Ru"
 ```
 这样会将密度分布归一化到表面, 同时以O原子的位置作为水分子的位置分析处理水分子的密度分布. 对于体系中存在 $OH^-$ 离子的体系可以使用`--update_water`的选项在每一帧更新水分子的位置, 不需要额外指定元素, 如:
 ```bash
-mdkits density [FILENAME] --update_water --cell 10,10,10 --atomic_mass=18.01528 --surface="name Pt and name Ru"
+mdkits md density [FILENAME] --update_water --cell 10,10,10 --atomic_mass=18.01528 --surface="name Pt and name Ru"
 ```
 输出的文件名为`density_water.dat`.
 
 ### 氢键
-
-#### 单个水分子
-
-#### 氢键分布
+`hb`用于分析体系中的氢键, 如分析体系中的氢键在z轴上的分布:
+```bash
+mdkits md hb [FILENAME] --cell 10,10,40 --surface "prop z < 10" --update_water
+```
+或分析单个水分子的氢键:
+```bash
+mdkits md hb [FILENAME] --cell 10,10,40 --index 15
+```
 
 ### 角度
+`angel`用于分析水分子中的二分向量和OH向量与表面法向量的夹角的丰度分布, 如分析距离表面 5 Å 的水分子的角度丰度分布:
+```bash
+mdkits md angle [FILENAME] --cell 10,10,40 --surface "name Pt" --water_height 5
+```
 
-#### 与表面法向量夹角分布
+### 偶极分布
+`diople`用于分析体系中的偶极($\cos \phi \rho_{H_2 O}$)分布, 如分析体系中的 $\cos \phi \rho_{H_2 O}$ 分布:
+```bash
+mdkits md diople [FILENAME] --cell 10,10,40 --surface "name Pt"
+```
 
-#### ion - O - ion 夹角分布
+### 径向分布函数(RDF)
+`rdf`用于分析两个`group`之间的径向分布函数, 如分析体系中的`O`元素与`H`元素之间的径向分布函数:
+```bash
+mdkits md rdf [FILENAME] --group "name O" "name H" --cell 10,10,40 --range 0.1 5
+```
 
-#### $\cos \phi \rho_{H_2 O}$ 分布
+### 均方位移(MSD)
+`msd`用于分析体系中某些原子的均方位移, 如分析体系中`Li`原子在z轴上的均方位移:
+```bash
+mdkits md msd [FILENAME] z "name Li"
+```
 
-### RDF
+### 监控
+`monitor`用于监控体系中原子高度, 键长和键角的变化, 如监控`index`为0的原子的高度:
+```bash
+mdkits md monitor [FILENAME] --cell 10,10,40 --surface "name Pt" -i 0
+```
+会输出0距离表面的高度随每一帧的变化, 如监控0-1的键长:
+```bash
+mdkits md monitor [FILENAME] --cell 10,10,40 --surface "name Pt" -i 0 -i 1
+```
+会输出0和1距离表面的高度和0-1之间的键长随每一帧的变化, 如监控1-0-2的键角:
+```bash
+mdkits md monitor [FILENAME] --cell 10,10,40 --surface "name Pt" -i 1 -i 0 -i 2
+```
+会输出1, 0, 2距离表面的高度, 1-0和0-2的键长和1-0-2的键角随每一帧的变化, 注意位于角上的原子应该放在中间
 
 ### 位置归一化
 `wrap`用于将轨迹文件中的原子位置进行归一化处理, 如将`[FILENAME]`中的原子位置归一化到晶胞中, 并输出为`wrapped.xyz`, 默认从`cp2k`的输出文件`input_inp`中读取`ABC`和`ALPHA_BETA_GAMMA`信息作为晶胞参数:
 ```bash
-mdkits wrap [FILENAME] 
+mdkits md wrap [FILENAME] 
 ```
 或指定`cp2k`的输入文件:
 ```bash
-mdkits wrap [FILENAME] --cp2k_input_file setting.inp
+mdkits md wrap [FILENAME] --cp2k_input_file setting.inp
 ```
 或指定晶胞参数:
 ```bash
-mdkits wrap [FILENAME] --cell 10,10,10
+mdkits md wrap [FILENAME] --cell 10,10,10
 ```
 默认的`[FILENAME]`为`*-pos-1.xyz`
 
 ## DFT 性质分析脚本
+`dft`为DFT性质分析工具, 其中包含多个分析工具
 ### PDOS
 `pdos`用于分析体系中的pdos, 分析[FILENAME]的d轨道的dos:
 ```bash
-mdkits pdos [FILENAME] -t d
+mdkits dft pdos [FILENAME] -t d
 ```
 
 ### CUBE 文件
 `cube`用于处理[`cube`格式](https://paulbourke.net/dataformats/cube/)的文件, 将其在z轴上进行平均:
 ```bash
-mdkits cube [FILENAME]
+mdkits dft cube [FILENAME]
 ```
 分析好的数据会输出为`cube.out`, 可以同时计算一个区域内的平均值:
 ```bash
-mdkits cube [FILENAME] -b 1 2
+mdkits dft cube [FILENAME] -b 1 2
 ```
 会将平均值打印在屏幕上, 同时记录在`cube.out`中的注释行.
 
 ## 建模
-`build`为界面的工具, 其中包含多个建模工具
+`build`为建模的工具, 其中包含多个建模工具
 
 ### 构建体相模型
 `bulk`用于构建体相模型, 如构建`Pt`的`fcc`体相模型:
 ```bash
-mdkits build_bulk Pt fcc
+mdkits build bulk Pt fcc
 ```
 构建为常胞模型:
 ```bash
-mdkits build_bulk Pt fcc --cubic
+mdkits build bulk Pt fcc --cubic
 ```
 构建一个`Caesium chloride`结构的模型:
 ```bash
-mdkits build_bulk CsCl cesiumchloride -a 4.123
+mdkits build bulk CsCl cesiumchloride -a 4.123
 ```
 构建一个`fluorite `结构的模型:
 ```bash
-mdkits build_bulk BaF2 fluorite -a 6.196
+mdkits build bulk BaF2 fluorite -a 6.196
 ```
 
 ### 构建表面模型
@@ -133,6 +175,60 @@ mdkits build surface Pt fcc111 2 2 3 --vacuum 15
 mdkits build surface C2 graphene 3 3 1 --vacuum 15
 ```
 
+### 从现有结构中构建表面模型
+`cut`用于从现有的结构中构建表面模型(模型必须为常胞模型), 如从`Pt_fcc.cif`中构建`fcc331`表面模型:
+```bash
+mdkits build cut Pt_fcc.cif --face 3 3 1 --size 3 3 5 --vacuum 15
+```
+
+### 在表面结构上添加吸附物
+`adsorbate`用于在表面结构上添加吸附物, 如在`surface.cif`上添加`H`原子:
+```bash
+mdkits build adsorbate surface.cif H --select "index 0" --height 1    
+```
+或在`Pt_fcc111_335.cif`上添加覆盖度为5的`H`原子:
+```bash
+mdkits build adsorbate Pt_fcc111_335.cif H --select "prop z > 16" --height 2 --cover 5
+```
+
+### 构建溶液相模型
+`solution`用于构建溶液相模型, 初次使用时应先安装`juliaup`:
+```bash
+mdkits build solution --install_julia
+```
+然后安装`Packmol`:
+```bash
+mdkits build solution --install_packmol
+```
+成功安装后就可以使用`solution`功能了, 如构建一个32个水分子的水盒子:
+```bash
+mdkits build solution --water_number 32 --cell 9.86,9.86,9.86
+```
+或构建一个含有离子的溶液:
+```bash
+mdkits build solution li.xyz k.xyz --water_number 64 --tolerance 2.5 -n 25 -n 45 --cell 15,15,15
+```
+其中`-n`的个数必须与指定的溶剂分子种类数量一致, 用于分别指定添加的溶剂的数量. 或者从`packmol`的输入文件中构建溶液相模型:
+```bash
+mdkits build solution input.pm input2.pm  --infile
+```
+
+### 构建界面模型
+`interface`用于构建界面模型, 如构建一个没有真空的界面模型:
+```bash
+mdkits build interface --slab Pt_fcc100_555.cif --sol water_160.cif
+```
+或构建一个带有气相模型的界面:
+```bash
+mdkits build interface --slab Pt_fcc100_555.cif --sol water_160.cif --cap ne --vacuum 20
+```
+
+### 构建超胞模型
+`supercell`用于构建超胞模型:
+```bash
+mdkits build supercell Li3PO4.cif 2 2 2
+```
+
 ## 其他
 ### 轨迹提取
 `extract`用于提取轨迹文件中的特定的帧, 如从`frames.xyz`中提取第 1000 帧到第 2000 帧的轨迹文件, 并输出为`1000-2000.xyz`, `-r`选项的参数与`Python`的切片语法一致:

mdkits-0.1.30/README.md

@@ -0,0 +1,295 @@
+# mdkits
+`mdkits` 提供了多种工具, 安装脚本:
+```bash
+pip install mdkits --upgrade
+```
+## 通用的选项参数类型
+1. `CELL TYPE`: 指定晶胞参数, 如`10,10,10`, `10,10,10,90,90,90`等
+2. `FRAME RANGE`: 指定帧范围, 如`1`, `1:10:2`等
+3. `--group`和`--surface`: 按[选择语言](https://userguide.mdanalysis.org/stable/selections.html)选取分析对象
+4. `--update_water`, `--distance` 和 `--angle`: 在分析轨迹的过程中开启动态更新水分子的功能
+
+## 轨迹文件处理脚本
+`md`为轨迹文件处理工具, 其中包含多个处理工具
+### 密度分布
+`density`用于分析体系中的某种元素沿z轴的密度分布, 如分析体系中的`O`元素沿z轴的密度分布:
+```bash
+mdkits md density [FILENAME] --group="name H" --cell [FILENAME]
+```
+这样会输出一个文件名为`density_name_H.dat`的文件, 第一列为z轴坐标, 第二列为浓度分布, 单位为 mol/L. 如果想输出为单位为 $g/cm^3$ 的密度分布, 可以指定`--atomic_mass` 选项, 如:
+```bash
+mdkits md density [FILENAME] --group="name H" --cell [FILENAME] --atomic_mass=1.00784
+```
+则输出单位为 $g/cm^3$ 的密度分布. 可以指定表面原子来将密度分布归一化到表面, 如:
+```bash
+mdkits md density [FILENAME] --group="name O" --cell 10,10,10 --atomic_mass=18.01528 --surface="name Pt and name Ru"
+```
+这样会将密度分布归一化到表面, 同时以O原子的位置作为水分子的位置分析处理水分子的密度分布. 对于体系中存在 $OH^-$ 离子的体系可以使用`--update_water`的选项在每一帧更新水分子的位置, 不需要额外指定元素, 如:
+```bash
+mdkits md density [FILENAME] --update_water --cell 10,10,10 --atomic_mass=18.01528 --surface="name Pt and name Ru"
+```
+输出的文件名为`density_water.dat`.
+
+### 氢键
+`hb`用于分析体系中的氢键, 如分析体系中的氢键在z轴上的分布:
+```bash
+mdkits md hb [FILENAME] --cell 10,10,40 --surface "prop z < 10" --update_water
+```
+或分析单个水分子的氢键:
+```bash
+mdkits md hb [FILENAME] --cell 10,10,40 --index 15
+```
+
+### 角度
+`angel`用于分析水分子中的二分向量和OH向量与表面法向量的夹角的丰度分布, 如分析距离表面 5 Å 的水分子的角度丰度分布:
+```bash
+mdkits md angle [FILENAME] --cell 10,10,40 --surface "name Pt" --water_height 5
+```
+
+### 偶极分布
+`diople`用于分析体系中的偶极($\cos \phi \rho_{H_2 O}$)分布, 如分析体系中的 $\cos \phi \rho_{H_2 O}$ 分布:
+```bash
+mdkits md diople [FILENAME] --cell 10,10,40 --surface "name Pt"
+```
+
+### 径向分布函数(RDF)
+`rdf`用于分析两个`group`之间的径向分布函数, 如分析体系中的`O`元素与`H`元素之间的径向分布函数:
+```bash
+mdkits md rdf [FILENAME] --group "name O" "name H" --cell 10,10,40 --range 0.1 5
+```
+
+### 均方位移(MSD)
+`msd`用于分析体系中某些原子的均方位移, 如分析体系中`Li`原子在z轴上的均方位移:
+```bash
+mdkits md msd [FILENAME] z "name Li"
+```
+
+### 监控
+`monitor`用于监控体系中原子高度, 键长和键角的变化, 如监控`index`为0的原子的高度:
+```bash
+mdkits md monitor [FILENAME] --cell 10,10,40 --surface "name Pt" -i 0
+```
+会输出0距离表面的高度随每一帧的变化, 如监控0-1的键长:
+```bash
+mdkits md monitor [FILENAME] --cell 10,10,40 --surface "name Pt" -i 0 -i 1
+```
+会输出0和1距离表面的高度和0-1之间的键长随每一帧的变化, 如监控1-0-2的键角:
+```bash
+mdkits md monitor [FILENAME] --cell 10,10,40 --surface "name Pt" -i 1 -i 0 -i 2
+```
+会输出1, 0, 2距离表面的高度, 1-0和0-2的键长和1-0-2的键角随每一帧的变化, 注意位于角上的原子应该放在中间
+
+### 位置归一化
+`wrap`用于将轨迹文件中的原子位置进行归一化处理, 如将`[FILENAME]`中的原子位置归一化到晶胞中, 并输出为`wrapped.xyz`, 默认从`cp2k`的输出文件`input_inp`中读取`ABC`和`ALPHA_BETA_GAMMA`信息作为晶胞参数:
+```bash
+mdkits md wrap [FILENAME] 
+```
+或指定`cp2k`的输入文件:
+```bash
+mdkits md wrap [FILENAME] --cp2k_input_file setting.inp
+```
+或指定晶胞参数:
+```bash
+mdkits md wrap [FILENAME] --cell 10,10,10
+```
+默认的`[FILENAME]`为`*-pos-1.xyz`
+
+## DFT 性质分析脚本
+`dft`为DFT性质分析工具, 其中包含多个分析工具
+### PDOS
+`pdos`用于分析体系中的pdos, 分析[FILENAME]的d轨道的dos:
+```bash
+mdkits dft pdos [FILENAME] -t d
+```
+
+### CUBE 文件
+`cube`用于处理[`cube`格式](https://paulbourke.net/dataformats/cube/)的文件, 将其在z轴上进行平均:
+```bash
+mdkits dft cube [FILENAME]
+```
+分析好的数据会输出为`cube.out`, 可以同时计算一个区域内的平均值:
+```bash
+mdkits dft cube [FILENAME] -b 1 2
+```
+会将平均值打印在屏幕上, 同时记录在`cube.out`中的注释行.
+
+## 建模
+`build`为建模的工具, 其中包含多个建模工具
+
+### 构建体相模型
+`bulk`用于构建体相模型, 如构建`Pt`的`fcc`体相模型:
+```bash
+mdkits build bulk Pt fcc
+```
+构建为常胞模型:
+```bash
+mdkits build bulk Pt fcc --cubic
+```
+构建一个`Caesium chloride`结构的模型:
+```bash
+mdkits build bulk CsCl cesiumchloride -a 4.123
+```
+构建一个`fluorite `结构的模型:
+```bash
+mdkits build bulk BaF2 fluorite -a 6.196
+```
+
+### 构建表面模型
+`surface`用于构建常见的表面模型, 骑用法为:
+```bash
+mdkits build surface [ELEMENT] [SURFACE_TYPE] [SIZE]
+```
+如构建`Pt`的`fcc111`表面模型:
+```bash
+mdkits build surface Pt fcc111 2 2 3 --vacuum 15
+```
+构建石墨烯表面:
+```bash
+mdkits build surface C2 graphene 3 3 1 --vacuum 15
+```
+
+### 从现有结构中构建表面模型
+`cut`用于从现有的结构中构建表面模型(模型必须为常胞模型), 如从`Pt_fcc.cif`中构建`fcc331`表面模型:
+```bash
+mdkits build cut Pt_fcc.cif --face 3 3 1 --size 3 3 5 --vacuum 15
+```
+
+### 在表面结构上添加吸附物
+`adsorbate`用于在表面结构上添加吸附物, 如在`surface.cif`上添加`H`原子:
+```bash
+mdkits build adsorbate surface.cif H --select "index 0" --height 1    
+```
+或在`Pt_fcc111_335.cif`上添加覆盖度为5的`H`原子:
+```bash
+mdkits build adsorbate Pt_fcc111_335.cif H --select "prop z > 16" --height 2 --cover 5
+```
+
+### 构建溶液相模型
+`solution`用于构建溶液相模型, 初次使用时应先安装`juliaup`:
+```bash
+mdkits build solution --install_julia
+```
+然后安装`Packmol`:
+```bash
+mdkits build solution --install_packmol
+```
+成功安装后就可以使用`solution`功能了, 如构建一个32个水分子的水盒子:
+```bash
+mdkits build solution --water_number 32 --cell 9.86,9.86,9.86
+```
+或构建一个含有离子的溶液:
+```bash
+mdkits build solution li.xyz k.xyz --water_number 64 --tolerance 2.5 -n 25 -n 45 --cell 15,15,15
+```
+其中`-n`的个数必须与指定的溶剂分子种类数量一致, 用于分别指定添加的溶剂的数量. 或者从`packmol`的输入文件中构建溶液相模型:
+```bash
+mdkits build solution input.pm input2.pm  --infile
+```
+
+### 构建界面模型
+`interface`用于构建界面模型, 如构建一个没有真空的界面模型:
+```bash
+mdkits build interface --slab Pt_fcc100_555.cif --sol water_160.cif
+```
+或构建一个带有气相模型的界面:
+```bash
+mdkits build interface --slab Pt_fcc100_555.cif --sol water_160.cif --cap ne --vacuum 20
+```
+
+### 构建超胞模型
+`supercell`用于构建超胞模型:
+```bash
+mdkits build supercell Li3PO4.cif 2 2 2
+```
+
+## 其他
+### 轨迹提取
+`extract`用于提取轨迹文件中的特定的帧, 如从`frames.xyz`中提取第 1000 帧到第 2000 帧的轨迹文件, 并输出为`1000-2000.xyz`, `-r`选项的参数与`Python`的切片语法一致:
+```bash
+mdkits extract frames.xyz -r 1000:2000 -o 1000-2000.xyz
+```
+或从`cp2k`的默认输出的轨迹文件`*-pos-1.xyz`文件中提取最后一帧输出为`extracted.xyz`(`extract`的默认行为):
+```bash
+mdkits extract
+```
+或每50帧输出一个结构到`./coord`目录中, 同时调整输出格式为`cp2k`的`@INCLUDE coord.xyz`的形式:
+```bash
+mdkits extract -cr ::50
+```
+
+### 结构文件转换
+`convert`用于将结构文件从一种格式转换为另一种格式, 如将`structure.xyz`转换为`out.cif`(默认文件名为`out`), 对于不储存周期性边界条件的文件, 可以使用`--cell`选项指定`PBC`:
+```bash
+mdkits convert -c structure.xyz --cell 10,10,10
+```
+将`structure.cif`转换为`POSCAR`:
+```bash
+mdkits convert -v structure.cif
+```
+将`structure.cif`转换为`structure_xyz.xyz`:
+```bash
+mdkits convert -c structure.cif -o structure_xyz
+```
+
+### 数据处理
+`data`用于对数据进行处理如:
+1. `--nor`: 对数据进行归一化处理
+2. `--gaus`: 对数据进行高斯过滤
+3. `--fold`: 堆数据进行折叠平均
+4. `--err`: 计算数据的误差棒   
+等
+
+### 绘图工具
+`plot`用于绘制数据图, `plot`需要读取`yaml`格式的配置文件进行绘图, `yaml`文件的形式如下:
+```yaml
+# plot mode 1
+figure1:
+  data:
+    legend1: ./data1.dat
+    legend2: ./data2.dat
+  x:
+    0: x-axis
+  y:
+    1: y-axis
+  x_range: 
+    - 5
+    - 15
+
+# plot mode 2
+figure2:
+  data:
+    y-xais: ./data.dat
+  x:
+    0: x-axis
+  y:
+    1: legend1
+    2: legend2
+    3: legend3
+    4: legend4
+    5: legend5
+  y_range:
+    - 0.5
+    - 6
+  legend_fontsize: 12
+
+# plot mode error
+12_dp_e_error:
+  data:
+    legend: ./error.dat
+  x:
+    0: x-axis
+  y:
+    1: y-axis
+  fold: dp
+  legend_fontsize: 12
+```
+如上`plot`支持三种绘图模式, `mode 1`, `mode 2`和`mode error`. `mode 1`用于绘制多组数据文件的同一列数据对比, `mode 2`用于绘制同一数据文件的不同列数据对比, `mode error`用于绘制均方根误差图.
+
+`plot`可以同时处理多个`yaml`文件, 每个`yaml`文件可以包含多个绘图配置, `mode 1`和`mode 2`的绘图配置可以自动识别, 但是`error`模式需要而外指定, 如:
+```bash
+mdkits plot *.yaml
+```
+和:
+```bash
+mdkits plot *.yaml --error
+```

{mdkits-0.1.28 → mdkits-0.1.30}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mdkits"
-version = "0.1.28"
+version = "0.1.30"
 description = "kits for md or dft"
 readme = "README.md"
 authors = ["jxxcr <jixxcr@qq.com>"]
@@ -22,6 +22,7 @@ pyyaml = "^6.0.1"
 Cp2kData = "^0.7.2"
 numpy = "^1.26.4"
 julia = "^0.6.2"
+tidynamics = "^1.1.2"
 
 [tool.poetry.group.dev.dependencies]
 pylint = "^2.17.4"

{mdkits-0.1.28 → mdkits-0.1.30}/src/mdkits/build_cli/adsorbate.py

@@ -18,6 +18,7 @@ from mdkits.util import arg_type, encapsulated_ase, out_err
 @click.option('--offset', type=click.Tuple([float, float]), help='adjust site', default=(0, 0), show_default=True)
 @click.option("--cover", type=int, help='cover the surface with adsorbate randomly')
 def main(atoms, adsorbate, cell, select, height, rotate, offset, cover):
+    """add adsorbate molcule to the surface"""
     if height is None:
         raise ValueError("height is required")
 

{mdkits-0.1.28 → mdkits-0.1.30}/src/mdkits/build_cli/build_surface.py

@@ -22,10 +22,7 @@ def surface_check(obj, surface_type):
 @click.option('--orth', is_flag=True, help='if specified and true, forces the creation of a unit cell with orthogonal basis vectors. if the default is such a unit cell, this argument is not supported')
 @click.option('--vacuum', type=float, help='designate vacuum of surface, default is None', default=0.1, show_default=True)
 def main(symbol, surface, size, kind, a, c, thickness, orth, vacuum):
-    #if args.primitive:
-    #    a = args.a * 0.7071 * 2
-    #else:
-    #    a = args.a
+    """build a common surface"""
 
     vacuum = vacuum / 2
     build_surface = surface_check(build, surface)

mdkits-0.1.30/src/mdkits/md_cli/angle.py

@@ -0,0 +1,122 @@
+import click
+from MDAnalysis import Universe
+from MDAnalysis.analysis.base import AnalysisBase
+import MDAnalysis
+import sys
+from mdkits.util import numpy_geo, encapsulated_mda, arg_type
+import numpy as np
+from .setting import common_setting
+
+
+class Angle_distribution(AnalysisBase):
+    def __init__(self, filename, cell, water_height, update_water, surface, distance_judg=None, angle_judg=(None, None), dt=0.001, bin_size=5):
+        u = Universe(filename)
+        u.trajectory.ts.dt = dt
+        u.dimensions = cell
+
+        self.u = u
+        self.atomgroup = u.select_atoms("all")
+        self.bin_size = bin_size
+        self.frame_count = 0
+        self.surface = surface
+        self.update_water = update_water
+        self.mid_z = u.dimensions[2]/2
+
+        self.normal_up = np.array([0, 0, 1])
+        self.normal_down = np.array([0, 0, -1])
+        self.total_angle = 180
+
+        if water_height is None:
+            sys.exit("Please specify the water height")
+        else:
+            self.water_height = water_height
+
+        if self.update_water:
+            self.distance_judg = distance_judg
+            self.angle_judg = angle_judg
+
+        if surface is not None:
+            self.surface_group = self.atomgroup.select_atoms(f"{surface}")
+            if self.surface_group.n_atoms == 0:
+                sys.exit("Please specify the correct surface group")
+        else:
+            sys.exit("Please specify a surface group")
+
+        super(Angle_distribution, self).__init__(self.atomgroup.universe.trajectory, verbose=True)
+    
+    def _prepare(self):
+        self.bin_num = int(self.total_angle / self.bin_size) + 2
+        self.angle_w_distribution = np.zeros(self.bin_num, dtype=np.float64)
+        self.angle_oh_distribution = np.zeros(self.bin_num, dtype=np.float64)
+
+    def _append(self, angle, anglew=True):
+        bins = np.floor(angle / self.bin_size).astype(int) + 1
+
+        if anglew:
+            bins = bins[bins < len(self.angle_w_distribution)]
+            np.add.at(self.angle_w_distribution, bins, 1)
+        else:
+            bins = bins[bins < len(self.angle_oh_distribution)]
+            np.add.at(self.angle_oh_distribution, bins, 1)
+
+
+    def _single_frame(self):
+        surface = numpy_geo.find_surface(self.surface_group.positions[:, 2])
+
+        if len(surface) == 1:
+            o_group = self.atomgroup.select_atoms(f"name O and prop z < {surface[0]+self.water_height}", updating=True)
+        else:
+            o_group = self.atomgroup.select_atoms(f"name O and (prop z < {surface[0]+self.water_height} or prop z > {surface[1]-self.water_height})", updating=True)
+        
+        h_group = self.atomgroup.select_atoms("name H")
+
+        if self.update_water:
+            o, oh1, oh2 = encapsulated_mda.update_water(self, o_group=o_group, h_group=h_group, distance_judg=self.distance_judg, angle_judg=self.angle_judg, return_index=False)
+        else:
+            o = o_group
+            oh1 = self.atomgroup[o_group.indices + 1]
+            oh2 = self.atomgroup[o_group.indices + 2]
+
+        vec1 = MDAnalysis.lib.distances.minimize_vectors(oh1.positions - o.positions, self.u.dimensions)
+        vec2 = MDAnalysis.lib.distances.minimize_vectors(oh2.positions - o.positions, self.u.dimensions)
+
+        bisector = numpy_geo.vector_between_two_vector(vec1, vec2)
+
+        angle_vec1 = np.hstack((numpy_geo.vector_vector_angle(vec1[o.positions[:, 2] < self.mid_z], self.normal_up), numpy_geo.vector_vector_angle(vec1[o.positions[:, 2] > self.mid_z], self.normal_down)))
+
+        angle_vec2 = np.hstack((numpy_geo.vector_vector_angle(vec2[o.positions[:, 2] < self.mid_z], self.normal_up), numpy_geo.vector_vector_angle(vec2[o.positions[:, 2] > self.mid_z], self.normal_down)))
+
+        angle_bisector = np.hstack((numpy_geo.vector_vector_angle(bisector[o.positions[:, 2] < self.mid_z], self.normal_up), numpy_geo.vector_vector_angle(bisector[o.positions[:, 2] > self.mid_z], self.normal_down)))
+
+        self._append(angle_vec1, anglew=False)
+        self._append(angle_vec2, anglew=False)
+        self._append(angle_bisector)
+
+        self.frame_count += 1
+
+    def _conclude(self):
+        if self.frame_count > 0:
+            average_angle_w = self.angle_w_distribution / self.frame_count
+            average_angle_oh = self.angle_oh_distribution / (self.frame_count*2)
+            bins_z = np.arange(len(average_angle_w)) * self.bin_size
+            conbined_data = np.column_stack((bins_z, average_angle_w, average_angle_oh))
+            np.savetxt("angle_distribution.dat", conbined_data, header="angle\tw_suf_dist\toh_suf_dist", fmt='%.5f', delimiter='\t')
+
+
+@click.command(name="angle", help="analysis angle between normal vectors and OH vector or bisector")
+@common_setting
+@click.option("--water_height", type=float, help="water height from surface")
+def main(filename, cell, water_height, update_water, distance, angle, surface, r):
+    """analysis angle between normal vectors and OH vector or bisector"""
+    a = Angle_distribution(filename, cell, water_height, update_water, distance_judg=distance, angle_judg=angle, surface=surface)
+    if r is not None:
+        if len(r) == 2:
+            a.run(start=r[0], stop=r[1])
+        elif len(r) == 3:
+            a.run(start=r[0], stop=r[1], step=r[2])
+    else:
+        a.run()
+
+
+if __name__ == "__main__":
+    main()