examples/example_pyapi.py

   1 #!/usr/bin/env python3
   2 #
   3 # This file is part of the GROMACS molecular simulation package.
   4 #
   5 # Copyright (c) 2015,2016, by the GROMACS development team, led by
   6 # Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7 # and including many others, as listed in the AUTHORS file in the
   8 # top-level source directory and at http://www.gromacs.org.
   9 #
  10 # GROMACS is free software; you can redistribute it and/or
  11 # modify it under the terms of the GNU Lesser General Public License
  12 # as published by the Free Software Foundation; either version 2.1
  13 # of the License, or (at your option) any later version.
  14 #
  15 # GROMACS is distributed in the hope that it will be useful,
  16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18 # Lesser General Public License for more details.
  19 #
  20 # You should have received a copy of the GNU Lesser General Public
  21 # License along with GROMACS; if not, see
  22 # http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24 #
  25 # If you want to redistribute modifications to GROMACS, please
  26 # consider that scientific software is very special. Version
  27 # control is crucial - bugs must be traceable. We will be happy to
  28 # consider code for inclusion in the official distribution, but
  29 # derived work must not be called official GROMACS. Details are found
  30 # in the README & COPYING files - if they are missing, get the
  31 # official version at http://www.gromacs.org.
  32 #
  33 # To help us fund GROMACS development, we humbly ask that you cite
  34 # the research papers on the package. Check out http://www.gromacs.org.
  35
  36 import sys
  37 from gromacs import Options
  38 from gromacs import TrajectoryAnalysis
  39
  40 class M(TrajectoryAnalysis.TrajectoryAnalysisModule):
  41     def __init__(self):
  42         super(M, self).__init__()
  43
  44     def initOptions(self, options, settings):
  45         print('python: initOptions')
  46
  47         settings.setHelpText('A simple test module')
  48
  49         self.optionsHolder = Options.PyOptionsHolder()
  50
  51         options.addOption(self.optionsHolder.doubleOption('double').description('double option from python').required())
  52         options.addOption(self.optionsHolder.selectionOption('sel').description('selection option from python').required())
  53
  54         settings.setFlag(TrajectoryAnalysis.TrajectoryAnalysisSettings.efRequireTop)
  55         print('python: inited')
  56
  57     def initAnalysis(self, settings, top):
  58         print('python: initAnalysis')
  59         print('There are {} atoms'.format(top.topology().atoms.nr))
  60         print('Topology name: {}'.format(top.topology().name))
  61
  62     def initAfterFirstFrame(self, settings, frame):
  63         print('python: first frame has {} atoms'.format(frame.natoms))
  64         print('Frame box:')
  65         print(frame.box[0], frame.box[1], frame.box[2])
  66
  67     def analyzeFrame(self, frnr, frame, pbc, data):
  68         sel = self.optionsHolder['sel']
  69         print('Frame {}, selected {} atoms'.format(frnr, sel.atomCount()))
  70
  71     def finishAnalysis(self, nframes):
  72         print('python: Analyzed {} frames'.format(nframes))
  73
  74     def writeOutput(self):
  75         print('python: writeOutput')
  76         print('double = {}'.format(self.optionsHolder['double']))
  77         print('sel = {}'.format(self.optionsHolder['sel']))
  78
  79 if __name__ == '__main__':
  80     TrajectoryAnalysis.TrajectoryAnalysisCommandLineRunner.runAsMain(M(), sys.argv)