python_packaging/src/gmxapi/__init__.py

   1 #
   2 # This file is part of the GROMACS molecular simulation package.
   3 #
   4 # Copyright (c) 2019, by the GROMACS development team, led by
   5 # Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6 # and including many others, as listed in the AUTHORS file in the
   7 # top-level source directory and at http://www.gromacs.org.
   8 #
   9 # GROMACS is free software; you can redistribute it and/or
  10 # modify it under the terms of the GNU Lesser General Public License
  11 # as published by the Free Software Foundation; either version 2.1
  12 # of the License, or (at your option) any later version.
  13 #
  14 # GROMACS is distributed in the hope that it will be useful,
  15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 # Lesser General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU Lesser General Public
  20 # License along with GROMACS; if not, see
  21 # http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23 #
  24 # If you want to redistribute modifications to GROMACS, please
  25 # consider that scientific software is very special. Version
  26 # control is crucial - bugs must be traceable. We will be happy to
  27 # consider code for inclusion in the official distribution, but
  28 # derived work must not be called official GROMACS. Details are found
  29 # in the README & COPYING files - if they are missing, get the
  30 # official version at http://www.gromacs.org.
  31 #
  32 # To help us fund GROMACS development, we humbly ask that you cite
  33 # the research papers on the package. Check out http://www.gromacs.org.
  34
  35 """gmxapi Python package for GROMACS.
  36
  37 This package provides Python access to GROMACS molecular simulation tools.
  38 Operations can be connected flexibly to allow high performance simulation and
  39 analysis with complex control and data flows. Users can define new operations
  40 in C++ or Python with the same tool kit used to implement this package.
  41
  42 """
  43
  44 __all__ = ['commandline_operation',
  45            'concatenate_lists',
  46            'function_wrapper',
  47            'join_arrays',
  48            'logger',
  49            'logical_not',
  50            'make_constant',
  51            'mdrun',
  52            'modify_input',
  53            'ndarray',
  54            'read_tpr',
  55            'subgraph',
  56            'while_loop',
  57            'NDArray',
  58            '__version__']
  59
  60 from ._logging import logger
  61 from .version import __version__
  62
  63 # Import utilities
  64 from .operation import computed_result, function_wrapper
  65 # Import public types
  66 from .datamodel import NDArray
  67 # Import the public operations
  68 from .datamodel import ndarray
  69 from .operation import concatenate_lists, join_arrays, logical_not, make_constant
  70 from .commandline import commandline_operation
  71 from .simulation import mdrun, modify_input, read_tpr
  72 # TODO: decide where this lives
  73 from .operation import subgraph
  74 # TODO: decide where this lives
  75 from .operation import while_loop