一个方便用于orca批处理的python模块

Graphite

CAUTION: This page is written in Chinese, If you read it via Google Translate, the code below will LOSE ITS FORMAT, so DO NOT copy and paste the code in translated page.

本模块(ChOrca)主要用于解决以下问题:
1.治好用惯了gview的人要用ORCA时, 粘来粘去的毛病
2.节省反复编写输入文件和建文件夹浪费的时间
3.简单调用cclib对输出文件进行解析

环境需求:
1.cclib -- 一个用于解析量化软件输出的库
2.需要自定义settings.json(下文提到)

注意:
本模块仅在windows下测试, linux理论可用.
By the way,  笔者用win10+GView+ORCA+本模块+VisualStudio Code集成终端用的很爽...虚拟机已删...

例: 本文件夹下有数个.gjf文件, 现在想要调用ORCA提取其中的坐标进行计算, 编写如下脚本:

1. import ChOrca
   
2. for gjf in ['a.gjf', 'b.gjf', 'c.gjf', ]:
   
3.     name = gjf.split('.')[0]
   
4.     calc = ChOrca.Calculation(name)
   
5.     calc.set_input_from_template('rank_1_opt', 'mem_1000mb', 0, 1, gjf)
   
6.     calc.run_orca()
   

复制代码

这里的'rank_1_opt', 'mem_1000mb'是我们在settings.json里的键, 实际调用其对应的值, 相当于设置了别名. settings.json最好与此脚本放在同一目录下.

1. {
   
2.     "orca_path": "D:\\ProgramFiles\\orca\\orca.exe",
   
3.     "template_keyword_excls": {
   
4.         "rank_1_opt": "!pal4 blyp def2-svp def2/j d3 miniprint"
   
5.     },
   
6.     "template_keyword_prcts": {
   
7.         "mem_1000mb": "%maxcore 1000"
   
8.     }
   
9. }

复制代码

模块包含的方法和参数, 在代码内部的docstring中都有提到. 源代码如下:

1. #coding: utf-8
   
2. """
   
3. This is a python module for calculation orca jobs conviently.
   
4. Import it and enjoy!
   
5. 
   
6. Lincense:   Whatever, use it, copy it, or modify it as you like.
   
7. Author:     T. H. Graphite
   
8. """
   
9. 
   
10. import json
    
11. import os
    
12. import re
    
13. import subprocess
    
14. import sys
    
15. 
    
16. import cclib
    
17. 
    
18. 
    
19. class Calculation():
    
20.     """Calculate orca jobs.
    
21.    
    
22.     Keyword Arguments:
    
23.         name {str}-- the instance name, for creating new files and dirs.
    
24.         work_dir {str} -- work directory, default: the path of module.
    
25. 
    
26.         Once a instance is created, a new directory work_dir/name will be made.
    
27.         Thus, all the calcultion will be done at this directory.
    
28. 
    
29.     Methods:
    
30.         load_settings(path)
    
31.         set_input(keyword_excl, keyword_prct, ncharge, nmulti, coordinates)
    
32.         set_input_from_xyz(keyword_excl, keyword_prct, ncharge, nmulti, path)
    
33. 
    
34.     Attributes:
    
35.         parse_json
    
36.         parse_result
    
37.     """
    
38. 
    
39. 
    
40.     def __init__(self, name, work_dir=sys.path[0]):
    
41.         self.name = name
    
42.         self.work_dir = work_dir
    
43.         os.chdir(self.work_dir)
    
44.         self.dir = os.path.join(self.work_dir, self.name)
    
45. 
    
46.         self.load_settings()
    
47. 
    
48.         if not os.path.exists(self.dir):
    
49.             os.mkdir(self.dir)
    
50. 
    
51.         self.input_path = os.path.join(self.dir, self.name + '.inp')
    
52.         self.output_path = os.path.join(self.dir, self.name + '.out')
    
53. 
    
54.     def load_settings(self, path=None):
    
55.         """Load settings from path.
    
56.         
    
57.         Keyword Arguments:
    
58.             path {str} -- the path of json settings file (default: work_dir/settings.json)
    
59.         """
    
60. 
    
61.         if path is None:
    
62.             path = os.path.join(self.work_dir, 'settings.json')
    
63. 
    
64.         try:
    
65.             settings_file = open(path, 'r')
    
66.             settings_dict = json.load(settings_file)
    
67.             self.orca_path = settings_dict['orca_path']
    
68.             self.template_keyword_excls = settings_dict['template_keyword_excls']
    
69.             self.template_keyword_prcts = settings_dict['template_keyword_prcts']
    
70. 
    
71.         except Exception:
    
72.             print('No settings file or invalid format. Exit.')
    
73.             exit()
    
74. 
    
75.     def set_input(self, keyword_excl, keyword_prct, ncharge, nmulti, coordinates):
    
76.         """Set input contents for calculation
    
77.         
    
78.         Arguments:
    
79.             keyword_excl {str} -- keywords start with a !
    
80.             keyword_prct {str} -- keyword start with a %, a.k.a. the 'block' in orca manual.
    
81.             ncharge {str or int} -- charge of molecule
    
82.             nmulti {str or int} -- multiplicity of molecule
    
83.             coordinates {str} -- coordinates in format like "C 1.000 1.000 1.000\nC 2.000 2.000 2.000..." .
    
84.         """
    
85. 
    
86.         self.input_content = "{kw_excl}\n{kw_prct}\n*xyz {nchg} {nmtp}\n{coord}\n*".format(
    
87.             kw_excl=keyword_excl,
    
88.             kw_prct=keyword_prct,
    
89.             nchg=str(ncharge),
    
90.             nmtp=str(nmulti),
    
91.             coord=coordinates)
    
92. 
    
93.     def set_input_from_xyz(self, keyword_excl, keyword_prct, ncharge, nmulti, path):
    
94.         """Set input contents for calculation, coordinates from a xyz-like file
    
95.         (.xyz, .gjf, or any file can be filter by the regex below)
    
96.         
    
97.         Arguments:
    
98.             keyword_excl {str} -- keywords start with a !
    
99.             keyword_prct {str} -- keyword start with a %
    
100.             ncharge {str or int} -- charge of molecule
     
101.             nmulti {str or int} -- multiplicity of molecule
     
102.             path {str} -- the path of the xyz-like file
     
103.         """
     
104. 
     
105.         regex = r'\ {0,2}[A-Z][a-z]?(\ *-?[0-9]*\.[0-9]*){3,}'
     
106.         pattern = re.compile(regex)
     
107. 
     
108.         file_object = open(path, 'r')
     
109.         coordinates = str()
     
110.         for line in file_object:
     
111.             if pattern.match(line):
     
112.                 coordinates += line
     
113.         file_object.close()
     
114. 
     
115.         self.set_input(keyword_excl, keyword_prct, ncharge, nmulti, coordinates)
     
116. 
     
117.     def set_input_from_template(self, temp_excl, temp_prct, ncharge, nmulti, path):
     
118.         """Like set_input_from_xyz, but use template names (in the settings file, see: load_settings)
     
119.         
     
120.         Arguments:
     
121.             temp_excl {str} -- a key of template_keyword_excls
     
122.             temp_prct {str} -- a key of template_keyword_prcts
     
123.             ncharge {str or int} -- charge of molecule
     
124.             nmulti {str or int} -- multiplicity of molecule
     
125.             path {str} -- the path of the xyz-like file
     
126.         """
     
127. 
     
128.         keyword_excl = self.template_keyword_excls[temp_excl]
     
129.         keyword_prct = self.template_keyword_prcts[temp_prct]
     
130. 
     
131.         self.set_input_from_xyz(keyword_excl, keyword_prct, ncharge, nmulti, path)
     
132.         
     
133. 
     
134.     def run_orca(self):
     
135.         """Running orca
     
136.         
     
137.         Returns:
     
138.             Boolean -- whether the calculation is terminated normally or not.
     
139.         """
     
140. 
     
141.         if not os.path.exists(self.orca_path):
     
142.             raise(EnvironmentError)
     
143. 
     
144.         input_file = open(self.input_path, 'w')
     
145.         input_file.write(self.input_content)
     
146.         input_file.close()
     
147. 
     
148.         run_command = self.orca_path + ' ' + self.input_path + ' > ' + self.output_path
     
149.         try:
     
150.             subprocess.check_call(run_command, shell=True)
     
151.             return True
     
152. 
     
153.         except subprocess.CalledProcessError:
     
154.             return False
     
155. 
     
156.     @property
     
157.     def parse_json(self):
     
158.         """Parse the output file using cclib.
     
159.         
     
160.         Returns:
     
161.             str -- a json string, including lots of interesting infos
     
162.         """
     
163. 
     
164.         parse_target = cclib.ccopen(self.output_path)
     
165.         if parse_target is not None:
     
166.             try:
     
167.                 print(parse_target)
     
168.                 parse_result = parse_target.parse()
     
169.                 json = cclib.ccwrite(
     
170.                     parse_result, outputtype='json', returnstr=True)
     
171.                 return json
     
172. 
     
173.             except Exception:
     
174.                 return None
     
175. 
     
176.     @property
     
177.     def parse_result(self):
     
178.         """The dictionary version of parse_json.
     
179.         
     
180.         Returns:
     
181.             dict -- a flattened dict
     
182.         """
     
183. 
     
184.         def walk(dictionary):
     
185.             for key, value in dictionary.items():
     
186.                 if isinstance(value, dict):
     
187.                     for tup in walk(value):
     
188.                         yield (key, ) + tup
     
189. 
     
190.                 else:
     
191.                     yield key, value
     
192. 
     
193.         result = dict()
     
194.         for tup in walk(json.loads(self.parse_json)):
     
195.             result.setdefault('/'.join(tup[:-1]), tup[-1])
     
196. 
     
197.         return result
     
198. 
     
199. 
     
200. if __name__ == '__main__':
     
201.     print(__doc__)
     
202. 
     

复制代码

ChrisZheng

代码粘过来全部乱码了 看起来很厉害的样子 战略马克