mdkits 0.1.1__py3-none-any.whl → 0.1.2__py3-none-any.whl

mdkits/cli/cube.py

@@ -1,59 +1,39 @@
 #!/usr/bin/env python3
 
-################################################
-# averange cp2k output(or some else file correspond to ase.io.read_cube_data) hartree.cube to z coordinate with python
-## file path is need to pay attention
-## cycle parameter is need to pay attention
-## buck range is need to pay attention
-################################################
+import numpy as np
+import click
+from mdkits.util import encapsulated_ase, os_operation
 
-from numpy import empty, array, mean, append, concatenate
-from argparse import ArgumentParser
-from util import encapsulated_ase, os_operation
 
+def ave_cube_data(cube_data, range):
+	mask = (cube_data[:,0] >= range[0]) & (cube_data[:,0] <=range[1])
+	bulk_cube_data = cube_data[mask]
+	ave_cube_data = np.mean(bulk_cube_data[:,1])
+	return ave_cube_data
 
-def array_type(string):
-	number_list = string.split(',')
-	number_array = array(number_list, dtype=float)
-	return number_array
 
+@click.command(name='cube')
+@click.argument('filename', type=click.Path(exists=True), default=os_operation.default_file_name('*.cube', last=True))
+@click.option('-b', '--bulk_range', type=(float, float), help='parameter to calculate mean value of bulk', default=None)
+@click.option('-o', type=str, help='output file name, default is "cube.out"', default='cube.out', show_default=True)
+def main(filename, bulk_range, o):
+	"""
+	analysis cube file
+	"""
 
-def buck_potential(xaxe, potential, range):
-	mix = concatenate((xaxe.reshape(-1, 1), potential.reshape(-1, 1)), axis=1)
-	mask = (mix[:,0] >= range[0]) & (mix[:,0] <=range[1])
-	buck_potential = mix[mask]
-	ave_potential = mean(buck_potential[:,1])
-	return ave_potential
+	cube_data = encapsulated_ase.ave_cube(filename)
 
+	## if bulk range is exit, out put a difference of cube_data
+	if bulk_range is not None:
+		bulk_cube_data = ave_cube_data(cube_data, bulk_range)
+		print(bulk_cube_data)
+		np.savetxt(o, cube_data, header=f'Z\tcube_data\t area average is: {bulk_cube_data}')
+	
+	else:
+		np.savetxt(o, cube_data, header='Z\tcube_data')
 
-# set argument
-parser = ArgumentParser(description='to handle cp2k output file hartree cube, name should be "hartree-*.cube"')
-parser.add_argument('file_name', type=str, nargs='?', help='hartree cube file', default=os_operation.default_file_name('*-v_hartree-1_*.cube', last=True))
-parser.add_argument('-b', '--buck_range', type=array_type, help='parameter to calculate mean value of buck', default=None)
-parser.add_argument('-o', type=str, help='output file name, default is "out.put"', default='hartree.out')
+	
 
-args = parser.parse_args()
-
-
-## init output potential file's shape, and define a z axe
-init_array = encapsulated_ase.ave_potential(args.file_name)
-potential = empty((0, init_array[0].shape[0]))
-z_coordinates = array((init_array[1])).reshape(-1, 1)
-
-potential = encapsulated_ase.ave_potential(args.file_name)[0]
-
-aved = mean(potential, axis=0)
-total_potential = append(z_coordinates, potential.reshape(-1, 1), axis=1)
-
-## if buck range is exit, out put a difference of potential
-if args.buck_range is not None:
-	buck_potential = buck_potential(z_coordinates, potential, args.buck_range)
-	print(buck_potential)
-	with open('hartree_potential.dat', 'w') as f:
-		f.write(f"{buck_potential}" + '\n')
-
-## write output
-with open(args.o, 'w') as f:
-	for value in total_potential:
-		f.write(" ".join(map(str, value)) + '\n')
 
+if __name__ == '__main__':
+	main()

mdkits/mdkits.py

@@ -5,7 +5,8 @@ from mdkits.cli import (
     extract,
     data,
     plot,
-    density
+    density,
+    cube,
 )
 
 
@@ -23,6 +24,7 @@ cli.add_command(extract.main)
 cli.add_command(data.main)
 cli.add_command(plot.main)
 cli.add_command(density.main)
+cli.add_command(cube.main)
 
 
 if __name__ == '__main__':

mdkits/util/encapsulated_ase.py

@@ -65,13 +65,13 @@ def rdf(chunk, cell, bin_size, name, parallel=True):
     ana.clear_cache()
 
 
-def ave_potential(filepath):
+def ave_cube(filepath):
     """
     function: average hartree file in z_coordinate
     parameter:
         filepath: hartree cube file path
     return:
-        z_potential: a list of potential alone z axes
+        z_cube_data: a list of cube data alone z axes
         z_coordinates: a list of coordinates of z axes
     """
     # read data from filepath
@@ -81,8 +81,8 @@ def ave_potential(filepath):
     step_size = atoms.cell[2, 2] / ( npoints - 1 )
     # average hartree file, and calculate z_coordinates
     z_coordinates = [i * step_size for i in range(npoints)]
-    z_potential = 27.2114 * data[:, :, :].sum(axis=(0, 1)) / ( data.shape[0] * data.shape[1] )
-    return z_potential, z_coordinates
+    z_cube_data = data[:, :, :].sum(axis=(0, 1)) / ( data.shape[0] * data.shape[1] )
+    return np.column_stack((z_coordinates, z_cube_data))
 
 
 def atoms_read_with_cell(file_name, cell=None, coord_mode=False, default_cell=np.array([0., 0., 0., 90., 90., 90.])):

{mdkits-0.1.1.dist-info → mdkits-0.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mdkits
-Version: 0.1.1
+Version: 0.1.2
 Summary: tools for md or dft
 License: MIT
 Keywords: molecular dynamics,density functional theory
@@ -82,9 +82,16 @@ mdkits wrap [FILENAME] --cell 10,10,10
 ## DFT 性质分析脚本
 ### PDOS
 
-### 静电势
-
-### 电荷差分
+### CUBE 文件
+`cube`用于处理[`cube`格式](https://paulbourke.net/dataformats/cube/)的文件, 将其在z轴上进行平均:
+```bash
+mdkits cube [FILENAME]
+```
+分析好的数据会输出为`cube.out`, 可以同时计算一个区域内的平均值:
+```bash
+mdkits cube [FILENAME] -b 1 2
+```
+会将平均值打印在屏幕上, 同时记录在`cube.out`中的注释行.
 
 ## 其他
 ### 轨迹提取

{mdkits-0.1.1.dist-info → mdkits-0.1.2.dist-info}/RECORD

@@ -5,7 +5,7 @@ mdkits/cli/build_bulk.py,sha256=dto5Wj-RcpzaGvyqTamo-3UfjQFQ_6cjy5_lMG0grPk,2117
 mdkits/cli/build_interface.py,sha256=i1YE5iwazKVsTdQ_DXalNYeA8oflORWFePgJin1AJM4,3537
 mdkits/cli/build_surface.py,sha256=tL9rSv6MROPRtVUu8JiPJbt4YdHFVKTZrEUaSd3rlzI,5657
 mdkits/cli/convert.py,sha256=s2q2Py7IVGNTctHgpHm66YFj_Rr8srnpuJudrMBI0oM,2014
-mdkits/cli/cube.py,sha256=XcJfsJ5Y2d5MQfD45p06_gV1fTJbDSrNhCnZ3Sz2Vb0,2233
+mdkits/cli/cube.py,sha256=G-QNup8W6J1-LCcEl1EHsV3nstd23byePDOcE_95t18,1176
 mdkits/cli/cut_surface.py,sha256=D1naCWj0QJE3AiInzy3SeGO37butothE3BS1rZsZ5MU,1425
 mdkits/cli/data.py,sha256=FGA4S9Cfo6WUJBSPWKOJrrZXHo_Qza-jNG1P_Dw7yi4,3262
 mdkits/cli/density.py,sha256=Y4grT8p7CsxggGYo_nGE9z_wlkJeQS5eYWKJQcoA014,5559
@@ -21,18 +21,18 @@ mdkits/cli/supercell.py,sha256=r5iddLw1NNzj7NTFlR2j_jpD1AMfrsxhA08bPwQvVvg,2059
 mdkits/cli/wrap.py,sha256=AUxGISuiCfEjdMYl-TKc2VMCPHSybWKrMIOTn_6kSp0,1043
 mdkits/config/__init__.py,sha256=ZSwmnPK02LxJLMgcYmNb-tIOk8fEuHf5jpqD3SDHWLg,1039
 mdkits/config/settings.yml,sha256=PY7u0PbFLuxSnd54H5tI9oMjUf-mzyADqSZtm99BwG0,71
-mdkits/mdkits.py,sha256=sBA61-E1lk-RJlOr_WcTkd7GjfxcHlBW_ASyg01s5os,471
+mdkits/mdkits.py,sha256=CHaivfpM5UN80CzmHHTeoTXuS3D_iozVh8MNaUT7nK0,511
 mdkits/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mdkits/util/arg_type.py,sha256=YUFhYShTYfUe7xajgUCiCuaeNLH-wxMXvlcMRax4zRM,1469
 mdkits/util/cp2k_input_parsing.py,sha256=6BFVsbBYxdauaUPrjr5h8JXk_R0bu7V3cbG2DEWWFlQ,1291
-mdkits/util/encapsulated_ase.py,sha256=dZU1i9Kw8rIyiQCCSDEXOs3q_z4dCMIo6bf5ooY9u0c,4089
+mdkits/util/encapsulated_ase.py,sha256=rmL80U3M8SsEU2M6QtLyiam2N1FIbrm5dK3P14p1EPg,4093
 mdkits/util/encapsulated_mda.py,sha256=td3H24u3eHOIS2nwPucfIaMxeaVxI77oFI8nnNhw7vo,2217
 mdkits/util/fig_operation.py,sha256=FwffNUtXorMl6qE04FipgzcVljEQii7wrNJUCJMyY3E,1045
 mdkits/util/numpy_geo.py,sha256=1Op8THoQeyqybSZAi7hVxohYCr4SzY6ndZC8_gAGXDA,3619
 mdkits/util/os_operation.py,sha256=tNRjniDwFqARMy5Rf6MUNmaQGpJlyifCpuN16r8aB2g,828
 mdkits/util/structure_parsing.py,sha256=mRPMJeih3O-ST7HeETDvBEkfV-1psT-XgxyYgDadV0U,4152
-mdkits-0.1.1.dist-info/entry_points.txt,sha256=xoWWZ_yL87S501AzCO2ZjpnVuYkElC6z-8J3tmuIGXQ,44
-mdkits-0.1.1.dist-info/LICENSE,sha256=VLaqyB0r_H7y3hUntfpPWcE3OATTedHWI983htLftcQ,1081
-mdkits-0.1.1.dist-info/METADATA,sha256=DNVdnQTU2P5cN0g5H9c6OUd6CMpYeVXggdmpZFKhL70,5622
-mdkits-0.1.1.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-mdkits-0.1.1.dist-info/RECORD,,
+mdkits-0.1.2.dist-info/entry_points.txt,sha256=xoWWZ_yL87S501AzCO2ZjpnVuYkElC6z-8J3tmuIGXQ,44
+mdkits-0.1.2.dist-info/LICENSE,sha256=VLaqyB0r_H7y3hUntfpPWcE3OATTedHWI983htLftcQ,1081
+mdkits-0.1.2.dist-info/METADATA,sha256=02-XrdxsXJYtoafQNYMpCmv-nGUIJ_NaM7SByFnRaVM,5964
+mdkits-0.1.2.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+mdkits-0.1.2.dist-info/RECORD,,