Jump to content

NEEMP:Reports: Difference between revisions

From WebChemistry Wiki
Francesco (talk | contribs)
No edit summary
Francesco (talk | contribs)
No edit summary
Line 5: Line 5:
''Step 1:''  
''Step 1:''  


* Generation of ''chg-stats-out-file'' in which for each atom the difference between the ''reference QM charge'' and the ''EEM charge'' is calculated ('''''figure 5'''''). Such a file can be obtained running '''NEEMP''' in ''quality validation'' mode with the option <code>--chg-stats-out</code> (see [[NEEMP:Examples#Example 8 - Quality validation | example]] or [[NEEMP:Modes#Quality validation | quality validation]] for details).
* Generation of ''chg-stats-out-file'' in which for each atom the difference between the ''reference QM charge'' and the ''EEM charge'' is calculated ('''''figure 5'''''). Such a file can be obtained running '''NEEMP''' in ''quality validation'' mode with the option <code>--chg-stats-out-file</code> (see [[NEEMP:Examples#Example 8 - Quality validation | example]] or [[NEEMP:Modes#Quality validation | quality validation]] for details).


''Step 2:''
''Step 2:''

Revision as of 11:38, 29 June 2016

Along with NEEMP we provide an handy python script to generate charge correlation graphs and quality assay reports, named nut-report.py.

SCRIPT BASIC USAGE:

Step 1:

  • Generation of chg-stats-out-file in which for each atom the difference between the reference QM charge and the EEM charge is calculated (figure 5). Such a file can be obtained running NEEMP in quality validation mode with the option --chg-stats-out-file (see example or quality validation for details).

Step 2:

  • Call nut-report.py with the above-mentioned file

./nut-report.py chg-stats-out-file

Requirements:

NB: the script has been tested for both Python 2.7 and Python 3.4, as well as for R 3.2.


Figure 5: Close-up from charge statistics file. Along with statistics for each molecule, ab-initio charges (3rd column), EEM charges (4th column) and their difference (5th column) are also printed out.

.

Once the script has been executed, a bunch of output files are generated in the chg-stats-out-file directory. In particular:

  • csv files containing per-atom charge information and values for several performance evaluating metrics for each atomic type and molecule
  • png files displaying the charge correlation graphs for the whole set and for each atomic type (as shown in figure 6 and figure 7 respectively)
  • html file gathering together all the previous information in an interactive and more easily readable report page (see figure 8 and figure 9 or click here for a more comprehensive view)
Figure 6: All atom correlation graph between QM charges (x axis) and EEM charges (y axis). Figure 7: Correlation graph between QM charges (x axis) and EEM charges (y axis) for O1 atomic type (oxygen with just single bonds).