NEEMP:Reports: Difference between revisions
Appearance
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
Along with '''NEEMP''' we provide an handy python script to generate charge correlation graphs and quality assay reports, named '''''nut-report.py'''''. | Along with '''NEEMP''' we provide an handy python script to generate charge correlation graphs and quality assay reports, named '''''nut-report.py'''''. | ||
'''''<u>SCRIPT BASIC USAGE:</u>''''' ''./nut-report.py chg-stats-out-file | '''''<u>SCRIPT BASIC USAGE:</u>''''' | ||
''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). | |||
''Step 2:'' | |||
* Call ''nut-report.py'' with the above-mentioned file | |||
<code>./nut-report.py chg-stats-out-file </code> | |||
'''''Requirements:''''' | '''''Requirements:''''' | ||
Line 11: | Line 21: | ||
'''NB''': the script has been tested for both Python 2.7 and Python 3.4, as well as for R 3.2. | '''NB''': the script has been tested for both Python 2.7 and Python 3.4, as well as for R 3.2. | ||
<br style="clear:both" /> | <br style="clear:both" /> |
Revision as of 11:37, 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
(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:
- Python (https://www.python.org/)
NB: the script has been tested for both Python 2.7 and Python 3.4, as well as for R 3.2.

.
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)