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

.. oe:namespace:: OESpruce

..  _OESpruce_OEMakeBioDesignUnits:

.. oe:function:: OEMakeBioDesignUnits

   .. attention::

      |TWOLANGUAGE|

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

      .. oe:api::

         OESystem::OEIterBase<OEBio::OEDesignUnit>* OEMakeBioDesignUnits(const OEChem::OEMolBase& structure,
                                                                         const OESpruce::OEStructureMetadata& metadata = OESpruce::OEStructureMetadata(),
                                                                         const OESpruce::OEMakeDesignUnitOptions& opts = OESpruce::OEMakeDesignUnitOptions())
         OESystem::OEIterBase<OEBio::OEDesignUnit>* OEMakeBioDesignUnits(const OEChem::OEMolBase& structure,
                                                                         const OEBio::OEDesignUnit& designUnitReference,
                                                                         const OESpruce::OEStructureMetadata& metadata = OESpruce::OEStructureMetadata(),
                                                                         const OESpruce::OEMakeDesignUnitOptions& opts = OESpruce::OEMakeDesignUnitOptions())

   .. oe:language:: python

      .. oe:api:: python

         OEMakeBioDesignUnits(structure: Union[OEGraphMol,OEMol,OEQMol],
                              metadata: OEStructureMetadata = OEStructureMetadata(),
                              opts: OEMakeDesignUnitOptions = OEMakeDesignUnitOptions()) -> Iterable[OEDesignUnit]
         OEMakeBioDesignUnits(structure: Union[OEGraphMol,OEMol,OEQMol],
                              designUnitReference: OEDesignUnit,
                              metadata: OEStructureMetadata = OEStructureMetadata(),
                              opts: OEMakeDesignUnitOptions = OEMakeDesignUnitOptions()) -> Iterable[OEDesignUnit]

   Return an iterator over all :ref:`OEDesignUnit <OEBio_OEDesignUnit>` objects that can be produced from the input :ref:`OEMolBase <OEChem_OEMolBase>`
   structure. A reference structure to be used for biounit extraction and structural superposition can be passed in through
   the `designUnitReference` argument, while information regarding the experimental data as well as basic options for
   constructing the design units themselves can be provided through the `metadata` and `opts` arguments, respectively.

   .. note::

      We strongly recommend running :ref:`OESpruceFilter <OESpruce_OESpruceFilter>` for standardization and filtering prior to running the design unit preparation

The input ``structure`` must have 3D coordinates assigned.

.. seealso::

  * :ref:`OEMakeDesignUnit <OESpruce_OEMakeDesignUnit>`, and :ref:`OESpruceFilter <OESpruce_OESpruceFilter>`