python_packaging/src/gmxapi/export_system.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019,2020,2021, 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 /*! \file
  36  * \brief Bindings for System and session launch.
  37  *
  38  * \ingroup module_python
  39  * \author M. Eric Irrgang <ericirrgang@gmail.com>
  40  */
  41
  42 #include "module.h"
  43
  44 #include "gmxapi/session.h"
  45 #include "gmxapi/status.h"
  46 #include "gmxapi/system.h"
  47 #include "gmxapi/version.h"
  48
  49 #include "pycontext.h"
  50 #include "pysystem.h"
  51
  52 // Note that PyCapsule symbols from Python.h should be imported by way of the pybind headers, so
  53 // let's not muddy the waters by explicitly including Python.h here unless we want to get more
  54 // particular about the CMake configuration.
  55
  56 namespace gmxpy
  57 {
  58
  59 namespace detail
  60 {
  61
  62 namespace py = pybind11;
  63
  64
  65 void export_system(py::module& m)
  66 {
  67     using ::gmxapi::System;
  68
  69     // The Session is a resource shared by active API operations.
  70     // We can't completely surrender ownership to Python because other API objects may refer to it.
  71     // We could use our own holder class instead of shared_ptr, but developers would
  72     // have to keep in mind that Python may make new references in different scopes
  73     // and threads, and pass references into other C++ code. Using shared_ptr
  74     // self-documents intent. Future implementations could refactor Session as a
  75     // dynamically accessed facet of the Context, which the API client would be
  76     // required to maintain and to pass to the API.
  77     py::class_<::gmxapi::Session, std::shared_ptr<::gmxapi::Session>> session(m, "MDSession");
  78     session.def("run", &::gmxapi::Session::run, "Run the simulation workflow");
  79     session.def("close",
  80                 &::gmxapi::Session::close,
  81                 "Shut down the execution environment and close the session.");
  82
  83     // Export system container class
  84     py::class_<System, std::shared_ptr<System>> system(m, "MDSystem");
  85     system.def("launch", &launch, "Launch the configured workflow in the provided context.");
  86
  87     // Module-level function
  88     m.def("from_tpr",
  89           &gmxpy::from_tpr,
  90           "Return a system container initialized from the given input record.");
  91 }
  92
  93 } // namespace detail
  94
  95 } // end namespace gmxpy