.. include:: ../../toolkit-substitutions

.. oe:namespace:: OESpruce



.. _OESpruce_OEProtonateDesignUnit:

.. oe:function:: OEProtonateDesignUnit


   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEProtonateDesignUnit(OEBio::OEDesignUnit& du,
                                    const OESpruce::OEProtonateDesignUnitOptions& opts = OEProtonateDesignUnitOptions())
         bool OEProtonateDesignUnit(OEBio::OEDesignUnit& du,
                                    const std::map<std::string, OEHeterogenMetadata>& metadata,
                                    const OESpruce::OEProtonateDesignUnitOptions& opts = OEProtonateDesignUnitOptions())

   .. oe:language:: python

      .. oe:api:: python

         OEProtonateDesignUnit(du: OEDesignUnit,
                               opts: OEProtonateDesignUnitOptions = OEProtonateDesignUnitOptions()) -> bool
         OEProtonateDesignUnit(du: OEDesignUnit,
                               metadata: StringHeterogenMetadataMap,
                               opts: OEProtonateDesignUnitOptions = OEProtonateDesignUnitOptions()) -> bool


   This function takes an input :ref:`OEDesignUnit <OEBio_OEDesignUnit>` (`du`) and it intelligently places
   hydrogens across all internal molecular components. Optionally, one may pass in a
   :ref:`OEHeterogenMetadata <OESpruce_OEHeterogenMetadata>` map keyed on the SMILES string for a given heterogen, as
   well as a set of general protonation options through the
   :ref:`OEProtonateDesignUnitOptions <OESpruce_OEProtonateDesignUnitOptions>` argument, `opts`.
