python_packaging/src/gmxapi/pycontext.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 Wrapper code for gmxapi::Context.
  37  *
  38  * \ingroup module_python
  39  * \author M. Eric Irrgang <ericirrgang@gmail.com>
  40  */
  41 #include "pycontext.h"
  42
  43 #include "gmxapi/exceptions.h"
  44 #include "gmxapi/gmxapi.h"
  45 #include "gmxapi/md.h"
  46 #include "gmxapi/session.h"
  47 #include "gmxapi/status.h"
  48 #include "gmxapi/version.h"
  49
  50 namespace py = pybind11;
  51
  52 namespace gmxpy
  53 {
  54
  55 void PyContext::setMDArgs(const MDArgs& mdArgs)
  56 {
  57     assert(context_);
  58     context_->setMDArgs(mdArgs);
  59 }
  60
  61 std::shared_ptr<gmxapi::Session> PyContext::launch(const gmxapi::Workflow& work)
  62 {
  63     assert(context_);
  64     std::shared_ptr<gmxapi::Session> session = nullptr;
  65
  66     // TODO: gmxapi::Workflow, gmxapi::MDWorkSpec, and gmxapi::MDModule need sensible consolidation.
  67     session = gmxapi::launchSession(context_.get(), work);
  68     if (!session)
  69     {
  70         throw gmxapi::ProtocolError("Context::launch() expected to produce non-null session.");
  71     }
  72
  73     for (auto&& module : workNodes_->getModules())
  74     {
  75         // TODO: This should be the job of the launching code that produces the Session.
  76         // Configure the restraints in a restraint manager made available to the session launcher.
  77         auto status = gmxapi::addSessionRestraint(session.get(), module);
  78     }
  79
  80     return session;
  81 }
  82
  83 std::shared_ptr<gmxapi::MDWorkSpec> PyContext::getSpec() const
  84 {
  85     assert(workNodes_);
  86     return workNodes_;
  87 }
  88
  89 std::shared_ptr<gmxapi::Context> PyContext::get() const
  90 {
  91     assert(context_);
  92     return context_;
  93 }
  94
  95 PyContext::PyContext() :
  96     context_{ std::make_shared<gmxapi::Context>(gmxapi::createContext()) },
  97     workNodes_{ std::make_shared<gmxapi::MDWorkSpec>() }
  98 {
  99     assert(context_);
 100     assert(workNodes_);
 101 }
 102
 103 void PyContext::addMDModule(const pybind11::object& force_object) const
 104 {
 105     if (!::gmxapi::Version::isAtLeast(0, 2, 1))
 106     {
 107         throw ::gmxapi::NotImplementedError("Feature requires gmxapi 0.2.1 with GROMACS 2021.3.");
 108     }
 109     // If force_object has a bind method, give it a PyCapsule with a pointer
 110     // to our C++ object.
 111     if (py::hasattr(force_object, "bind"))
 112     {
 113         auto spec     = getSpec();
 114         auto holder   = new gmxapi::MDHolder(spec);
 115         holder->name_ = "pygmx holder";
 116         auto deleter  = [](PyObject* o) {
 117             if (PyCapsule_IsValid(o, gmxapi::MDHolder_Name))
 118             {
 119                 auto holder_ptr = (gmxapi::MDHolder*)PyCapsule_GetPointer(o, gmxapi::MDHolder_Name);
 120                 delete holder_ptr;
 121                 // \todo double-check whether there is something we should do to invalidate a PyCapsule.
 122             }
 123         };
 124         auto       capsule = py::capsule(holder, gmxapi::MDHolder_Name, deleter);
 125         py::object bind    = force_object.attr("bind");
 126         // py::capsule does not have bindings and does not implicitly convert to py::object
 127         py::object obj = capsule;
 128         bind(obj);
 129     }
 130     else
 131     {
 132         // Note: Exception behavior is likely to change.
 133         // Ref: https://github.com/kassonlab/gmxapi/issues/125
 134         throw py::value_error("Argument must provide a `bind` method.");
 135     }
 136 } // namespace gmxpy
 137
 138 } // end namespace gmxpy