.. _section_example_oechem_molgrep:

Perform substructure searches
================================================================================

A program that searches a molecule file using a SMARTS pattern. Flags
include: ``-c``, count the number of matches, ``-o``, output the
matches to a file, ``-p``, the SMARTS pattern to use, ``-r``, do the
reverse search ``i.e.`` all molecules that don't match the
SMARTS.

Example
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. code-block:: console

      prompt> molgrep -p 'c1ccccc1' -c dbase.oeb.gz
      prompt> molgrep -r -p 'c1ccccc1' -i dbase.oeb.gz -o output.oeb.gz

.. oe:language:: python

   .. code-block:: console

      prompt> molgrep.py -p 'c1ccccc1' -c dbase.oeb.gz
      prompt> molgrep.py -r -p 'c1ccccc1' -i dbase.oeb.gz -o output.oeb.gz

.. oe:language:: java

   .. code-block:: console

      prompt> MolGrep -p 'c1ccccc1' -c dbase.oeb.gz
      prompt> MolGrep -r -p 'c1ccccc1' -i dbase.oeb.gz -o output.oeb.gz

.. oe:language:: csharp

   .. code-block:: console

      prompt> MolGrep -p 'c1ccccc1' -c dbase.oeb.gz
      prompt> MolGrep -r -p 'c1ccccc1' -i dbase.oeb.gz -o output.oeb.gz


Code
--------------------------------------------------------------------------------

.. oe:language:: c++

   .. only:: oehtml

      .. admonition:: Download code

         :download:`molgrep.cpp <../../../../../sublibs/tklibs/oechem/examples/molgrep.cpp>`

   .. only:: oepdf

      .. oe:source:: molgrep.cpp
         :language: c++

.. oe:language:: python

   .. only:: oehtml

      .. admonition:: Download code

         :download:`molgrep.py <../../../../../wrappers/python/examples/oechem/molgrep.py>`


      ..    literalinclude:: ../../../../../wrappers/python/examples/oechem/molgrep.py


   .. only:: oepdf

      .. oe:source:: molgrep.py
         :language: python

.. oe:language:: java

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MolGrep.java <../../../../../wrappers/java/examples/openeye/examples/oechem/MolGrep.java>`

   .. only:: oepdf

      .. oe:source:: MolGrep.java
         :language: java

.. oe:language:: csharp

   .. only:: oehtml

      .. admonition:: Download code

         :download:`MolGrep.cs <../../../../../wrappers/csharp/Csharp-Examples/OEChem/MolGrep.cs>`

   .. only:: oepdf

      .. oe:source:: MolGrep.cs
         :language: csharp

.. seealso::

   * :ref:`OESubSearch <OEChem_OESubSearch>` class
   * :oe:meth:`OEChem::OESubSearch::SingleMatch` method
   * :oe:func:`OEChem::OEPrepareSearch` function
