summaryrefslogtreecommitdiff
path: root/cad/src/analysis/ESP/files_nh.py
blob: f45ef468c1ffb8eeec95a21652447de882a8686a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
# Copyright 2005-2009 Nanorex, Inc.  See LICENSE file for details. 
"""
files_nh.py

@author; Mark
@version: $Id$
@copyright: 2005-2009 Nanorex, Inc.  See LICENSE file for details. 

History:

Created by Mark.
"""

from analysis.ESP.NanoHiveUtils import get_nh_simspec_filename
from analysis.ESP.NanoHiveUtils import get_nh_workflow_filename
from analysis.ESP.NanoHiveUtils import get_nh_mmp_filename
from analysis.ESP.NanoHiveUtils import get_nh_home

def write_nh_simspec_file(sim_name, sim_parms, sims_to_run, results_to_save, output_dir):
    """
    Writes the Nano-Hive Sim specification file, which is an XML file that describes the
    simulation environment, plugin selection and plugin parameters.
    """
    # The Nano-Hive Sim Spec file has 4 different sections that must be written in the following order:
    # 1. Header Section
    # 2. Physical Interaction Plugin(s) Section
    # 3. Results Plugin(s) Section
    # 4. Footer Section.
    # Mark 050915.
    
    simspec_fname = get_nh_simspec_filename(sim_name)
    workflow_fname = get_nh_workflow_filename(sim_name)
    mmp_fname = get_nh_mmp_filename(sim_name)
    
    f = open(simspec_fname,'w') # Open Nano-Hive Sim Spec file.
    
    sp = sim_parms
    
    write_nh_header(f, sp.desc, sp.iterations, sp.spf, sp.temp, workflow_fname, mmp_fname)
    
    # Need to ask Brian about conditions for Bond record to be written.
    if 0: 
        write_nh_bond_calc_rec(f)
    
    # Physical Interaction Plugins ########################################
    
    if "MPQC_ESP" in sims_to_run:
        write_nh_mpqc_esp_plane_rec(f, sp.esp_image, output_dir)
        
    if "MPQC_GD" in sims_to_run:
        write_nh_mpqc_gd_rec(f)
            
    if "AIREBO" in sims_to_run:
        write_nh_airebo_rec(f)

    # Results Plugins ########################################
    
    if "MEASUREMENTS_TO_FILE" in results_to_save:
        write_nh_measurements_to_file_results_rec(f, output_dir)

    if "POVRAYVIDEO" in results_to_save:
        write_nh_povrayvideo_results_rec(f, sim_name, output_dir)

    if "NETCDF" in results_to_save:
        write_nh_netcdf_results_rec(f, output_dir)
    
    # Footer ########################################
    write_nh_footer(f)
    
    f.close()
            
def write_nh_workflow_file(sim_name):
    """
    Writes the Nano-Hive Workflow file, which is a TCL script used by Nano-Hive to
    run the simulation.  It describes the workflow of the simulation.
    """
    workflow_fname = get_nh_workflow_filename(sim_name)
    
    f = open(workflow_fname,'w')

    f.write ('NH_Import $inFile\n\n')
    f.write ('NH_Calculate 0 $traverser\n')
    f.write ('NH_Calculate 0 $espImage $traverser\n')
    f.write ('NH_Intermediate 0 $simResult\n\n')
    f.write ('NH_Final $simResult\n')
    
    f.close()


    
def write_nh_header(f, desc, iter, spf, temp, workflow_fname, mmp_fname):
    """
    Writes the Nano-Hive Sim specification file, which is an XML file that describes the
    simulation environment, plugin selection and plugin parameters.
    """
    nh_home = get_nh_home()
    
    #print "files_nh.write_nh_header(): Nano-Hive Home:", nh_home
    
    # Write SimSpec header ########################################
    
    f.write ('<simulation>\n')
    f.write('  <description>%s</description>\n' % desc)
    f.write('\n')
    f.write('  <parameter name="timeQuantumLength" value="%e" />\n' % spf)
    f.write('  <parameter name="environmentTemperature" value="%d" />\n' % temp)
    f.write('  <parameter name="startIteration" value="0" />\n')
    f.write('  <parameter name="iterations" value="%d" />\n' % iter)
    f.write('\n')
    f.write('  <simulationFlow file="%s">\n' % workflow_fname)
    f.write('    <input name="inFile" type="nanorexMMP" file="%s" />\n' % mmp_fname)
    
    # This traverser is for the local machine.
    f.write('    <traverser name="traverser" plugin="RC_Traverser" />\n')
    
def write_nh_footer(f):

    f.write('\n')
    f.write('  </simulationFlow>\n')
    f.write('</simulation>\n')

def write_nh_bond_calc_rec(f):
    f.write('    <calculator name="bondCalculator" plugin="BondCalculator" />\n')
    
# == Physical Interaction Plug-ins ==========================
    
def write_nh_mpqc_esp_plane_rec(f, esp_image, output_dir):
    
    nh_home = get_nh_home()
    
    cpnt = esp_image.center * 1e-10
    centerPoint = (float(cpnt[0]), float(cpnt[1]), float(cpnt[2]))
    #print "ESP Image CenterPoint =", centerPoint
        
    npnt = cpnt + (esp_image.planeNorm  * 1e-10)
    
    # This is a temporary workaround until Brian fixes the normalPoint Y value issue (must be positive).
    # This forces ESP Images to be oriented in the X-Z plane until it is fixed.
    # Mark 050927.
    # normalPoint = (0.0, 0.0, 1.0) + cpnt
    normalPoint = (float(npnt[0]), float(npnt[1]), float(npnt[2])) # KEEP THIS!!!
    #print "ESP Image NormalPoint =", normalPoint
        
    resolution = esp_image.resolution
    # print "ESP Image Resolution =", resolution
        
    cutoffHeight = esp_image.image_offset * 1e-10
    #print "ESP Image cutoffHeight =", cutoffHeight
    cutoffWidth = esp_image.edge_offset * 1e-10
    #print "ESP Image cutoffWidth =", cutoffWidth
    outputLength = esp_image.width * 1e-10
    #print "ESP Image outputLength =", outputLength

    multi = esp_image.multiplicity
    
    f.write('\n')
    f.write('    <calculator name="espImage" plugin="MPQC_SClib">\n')
    f.write('      <parameter name="logDirectory" value="%s/log" />\n' % nh_home)
    f.write('      <parameter name="dataDirectory" value="%s/data/MPQC_SClib" />\n' % nh_home)
    f.write('      <parameter name="basis" value="STO-3G" />\n')
    f.write('      <parameter name="method" value="HF" />\n')
    f.write('      <parameter name="desiredEnergyAccuracy" value="1.0e-5" />\n')
    f.write('      <parameter name="multiplicity" value="%d" />\n' % multi)
    f.write('\n')
    f.write('      <parameter name="outputType" value="ESPplane" />\n')
    f.write('      <parameter name="resolution" value="%d" />\n' % resolution)
    f.write('\n')
    f.write('      <parameter name="centerPoint" value="%.2e %.2e %.2e" />\n' % centerPoint)
    f.write('      <parameter name="normalPoint" value="%.2e %.2e %.2e" />\n' % normalPoint)
    f.write('      <parameter name="cutoffHeight" value="%.2e" />\n' % cutoffHeight)
    f.write('      <parameter name="cutoffWidth" value="%.2e" />\n' % cutoffWidth)
    f.write('      <parameter name="outputLength" value="%.2e" />\n' % outputLength)
    f.write('    </calculator>\n')
    f.write('\n')
    f.write('    <result name="simResult" plugin="_ESP_Image">\n')
    f.write('      <parameter name="outputFilename" value="%s\\%s.png" />\n' % (output_dir, esp_image.name))
    f.write('      <parameter name="xaxisOrient" value="%d" />\n' % esp_image.xaxis_orient)
    f.write('      <parameter name="yaxisOrient" value="%d" />\n' % esp_image.yaxis_orient)
    f.write('    </result>\n')

def write_nh_mpqc_gd_rec(f):

    nh_home = get_nh_home()
    
    f.write('\n')
    f.write('    <calculator name="qmDynamicsInteraction" plugin="MPQC_SClib">\n')
    f.write('      <parameter name="logDirectory" value="%s/log" />\n' % nh_home)
    f.write('      <parameter name="dataDirectory" value="%s/data/MPQC_SClib" />\n' % nh_home)
    f.write('      <parameter name="basis" value="STO-3G" />\n')
    f.write('      <parameter name="method" value="HF" />\n')
    f.write('      <parameter name="gradientDynamics" value="yes" />\n')
    f.write('      <parameter name="deltaTbyTau" value="1.0" />\n')
    f.write('    </calculator>\n')
            

def write_nh_mpqc_gd_rec(f):
        
    nh_home = get_nh_home()
    
    f.write('\n')
    f.write('    <calculator name="physicalInteraction" plugin="REBO_MBM">\n')
    f.write('      <parameter name="dataDirectory" value="%s/data/REBO_MBM" />\n' % nh_home)
    f.write('    </calculator>\n')

#== Results Plug-ins ==========================

def write_nh_measurements_to_file_results_rec(f, output_dir):
    
    f.write('\n')
    f.write('    <result name="MeasurementSetToFile" plugin="MeasurementSetToFile">\n')
    f.write('      <parameter name="outputInterval" value="1" />\n')
    f.write('      <parameter name="outputFile"\n')
    f.write('        value="%s/data.txt" />\n' % output_dir)
    f.write('      <parameter name="datumSeparator" value="\t" />\n')
    f.write('    </result>\n')

def write_nh_povrayvideo_results_rec(f, output_dir, partname):
    
    nh_home = get_nh_home()
        
    # Need subdirectory for all the POV-Ray pov files.
    # Also need to add lighting, scene setup, background color, etc.
    f.write('\n')
    f.write('    <result name="POVRayVideo" plugin="POVRayVideo">\n')
    f.write('      <parameter name="outputInterval" value="1" />\n')
    f.write('      <parameter name="lengthMultiplier" value="1e10" />\n')
    f.write('      <parameter name="outputDirectory"\n')
    f.write('        value="%s/povray" />\n' % output_dir)
    f.write('      <parameter name="outputIdentifier" value="%s" />\n' % partname)
    # POV-Ray template.  Mark needs to write the include file for lighting and camera angle(s)
    # and put that file in the appropriate place (outdir/povray).
    f.write('      <parameter name="povTemplateFilename"\n')
    f.write('        value="%s/data/pov.tmplt" />')
    f.write('      <parameter name="mpegTemplateFilename"\n')
    f.write('        value="%s/data/mpeg_encode.param.tmplt" />\n' % nh_home)
    f.write('    </result>\n')

def write_nh_netcdf_results_rec(f, output_dir):
    
    f.write('\n')
    f.write('    <result name="simResult" plugin="NetCDF_DataSet">\n')
    f.write('      <parameter name="outputInterval" value="1" />\n')
    f.write('      <parameter name="outputDirectory"\n')
    f.write('        value="%s" />\n' % output_dir)
    f.write('      <parameter name="maxDataSets" value="-1" />\n')
    f.write('    </result>\n')

# end