.. _chapter_examplesoechem_summary:

********************************************************************************
OEChem Examples
********************************************************************************

The following table lists the currently available **OEChem TK** examples.

.. _section_example_oechem_molecule_processing:

Molecule Processing
================================================================================

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`convert<section_example_oechem_convert>`
        - converting molecule files
      * - :ref:`catmols<section_example_oechem_catmols>`
        - concatenating molecules
      * - :ref:`parts2mols<section_example_oechem_parts2mols>`
        - splitting multicomponent molecules
      * - :ref:`molextract<section_example_oechem_molextract>`
        - extracting molecules by title
      * - :ref:`uniqmol<section_example_oechem_uniqmol>`
        - writing out unique molecules (canonical SMILES)
      * - :ref:`uniqinchi<section_example_oechem_uniqinchi>`
        - writing out unique molecules (InChI)
      * - :ref:`randomizeatoms<section_example_oechem_randomizeatoms>`
        - randomizing atoms of molecules
      * - :ref:`cansmi<section_example_oechem_cansmi>`
        - generating canonical smiles
      * - :ref:`sizefilter<section_example_oechem_sizefilter>`
        - filtering molecules by weight or heavy atom count
      * - :ref:`stripsalts<section_example_oechem_stripsalts>`
        - stripping salt
      * - :ref:`ringsubset<section_example_oechem_ringsubset>`
        - extracting rings
      * - :ref:`extractscaffold<section_example_oechem_extractscaffold>`
        - extracting molecule scaffolds
      * - :ref:`randomsample<section_example_oechem_randomsample>`
        - extracting random molecule subset
      * - :ref:`molchunk<section_example_oechem_molchunk>`
        - split molecule file into N chunks or chunks of size N  

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`convert.py<section_example_oechem_convert>`
        - converting molecule files
      * - :ref:`catmols.py<section_example_oechem_catmols>`
        - concatenating molecules
      * - :ref:`parts2mols.py<section_example_oechem_parts2mols>`
        - splitting multicomponent molecules
      * - :ref:`molextract.py<section_example_oechem_molextract>`
        - extracting molecules by title
      * - :ref:`uniqmol.py<section_example_oechem_uniqmol>`
        - writing out unique molecules (canonical SMILES)
      * - :ref:`uniqinchi.py<section_example_oechem_uniqinchi>`
        - writing out unique molecules (InChI)
      * - :ref:`randomizeatoms.py<section_example_oechem_randomizeatoms>`
        - randomizing atoms of molecules
      * - :ref:`cansmi.py<section_example_oechem_cansmi>`
        - generating canonical smiles
      * - :ref:`sizefilter.py<section_example_oechem_sizefilter>`
        - filtering molecules by weight or heavy atom count
      * - :ref:`stripsalts.py<section_example_oechem_stripsalts>`
        - stripping salt
      * - :ref:`ringsubset.py<section_example_oechem_ringsubset>`
        - extracting rings
      * - :ref:`extractscaffold.py<section_example_oechem_extractscaffold>`
        - extracting molecule scaffolds
      * - :ref:`randomsample.py<section_example_oechem_randomsample>`
        - extracting random molecule subset
      * - :ref:`molchunk.py<section_example_oechem_molchunk>`
        - split molecule file into N chunks or chunks of size N

.. oe:language:: java csharp

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`Convert<section_example_oechem_convert>`
        - converting molecule files
      * - :ref:`CatMols<section_example_oechem_catmols>`
        - concatenating molecules
      * - :ref:`Parts2Mols<section_example_oechem_parts2mols>`
        - splitting multicomponent molecules
      * - :ref:`MolExtract<section_example_oechem_molextract>`
        - extracting molecules by title
      * - :ref:`UniqMol<section_example_oechem_uniqmol>`
        - writing out unique molecules (canonical SMILES)
      * - :ref:`UniqInchi<section_example_oechem_uniqinchi>`
        - writing out unique molecules (InChI)
      * - :ref:`RandomizeAtoms<section_example_oechem_randomizeatoms>`
        - randomizing atoms of molecules
      * - :ref:`CanSmi<section_example_oechem_cansmi>`
        - generating canonical smiles
      * - :ref:`SizeFilter<section_example_oechem_sizefilter>`
        - filtering molecules by weight or heavy atom count
      * - :ref:`StripSalts<section_example_oechem_stripsalts>`
        - stripping salt
      * - :ref:`RingSubset<section_example_oechem_ringsubset>`
        - extracting rings
      * - :ref:`ExtractScaffold<section_example_oechem_extractscaffold>`
        - extracting molecule scaffolds
      * - :ref:`RandomSample<section_example_oechem_randomsample>`
        - extracting random molecule subset
      * - :ref:`MolChunk<section_example_oechem_molchunk>`
        - split molecule file into N chunks or chunks of size N

.. _section_example_oechem_reactions:

Reactions
================================================================================

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`unimolrxn<section_example_oechem_unimolrxn>`
        - performing a reaction
      * - :ref:`libgen<section_example_oechem_libgen>`
        - generating a library

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`applytransform.py<section_example_oechem_applytransform>`
        - use a SMIRKS specification to perform individual reaction transformations on single molecules
      * - :ref:`applytransformiter.py<section_example_oechem_applytransformiter>`
        - use a SMIRKS specification to perform individual reaction transformations on each input molecule
      * - :ref:`unimolrxn.py<section_example_oechem_unimolrxn>`
        - perform a reaction
      * - :ref:`libgen.py<section_example_oechem_libgen>`
        - generate a library

.. oe:language:: java csharp

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`UniMolRxn<section_example_oechem_unimolrxn>`
        - performing a reaction
      * - :ref:`LibGen<section_example_oechem_libgen>`
        - generating a library

.. _section_example_oechem_molecule_searching:

Molecule Searching
================================================================================

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`molgrep<section_example_oechem_molgrep>`
        - performing substructure search
      * - :ref:`makefastss<section_example_oechem_makefastss>`
        - generating database for fast substructure search
      * - :ref:`searchfastss<section_example_oechem_searchfastss>`
        - performing search on substructure database file

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`molgrep.py<section_example_oechem_molgrep>`
        - performing substructure search
      * - :ref:`makefastss.py<section_example_oechem_makefastss>`
        - generating database for fast substructure search
      * - :ref:`searchfastss.py<section_example_oechem_searchfastss>`
        - performing search on substructure database file

.. oe:language:: java csharp

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`MolGrep<section_example_oechem_molgrep>`
        - performing substructure search

.. _section_example_oechem_molecule_alignment:

Molecule Alignment
================================================================================

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`mcs3dalign<section_example_oechem_mcs3dalign>`
        - aligning molecules by maximum common substructure
      * - :ref:`cliquealign<section_example_oechem_cliquealign>`
        - aligning molecules by clique match
      * - :ref:`smartsalign<section_example_oechem_smartsalign>`
        - aligning molecules by SMARTS match
      * - :ref:`rmsd<section_example_oechem_rmsd>`
        - aligning multiconformer molecules

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`mcs3dalign.py<section_example_oechem_mcs3dalign>`
        - aligning molecules by maximum common substructure
      * - :ref:`cliquealign.py<section_example_oechem_cliquealign>`
        - aligning molecules by clique match
      * - :ref:`smartsalign.py<section_example_oechem_smartsalign>`
        - aligning molecules by SMARTS match
      * - :ref:`rmsd.py<section_example_oechem_rmsd>`
        - aligning multiconformer molecules

.. oe:language:: java csharp

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`MCS3DAlign<section_example_oechem_mcs3dalign>`
        - aligning molecules by maximum common substructure
      * - :ref:`CliqueAlign<section_example_oechem_cliquealign>`
        - aligning molecules by clique match
      * - :ref:`SMARTSAlign<section_example_oechem_smartsalign>`
        - aligning molecules by SMARTS match
      * - :ref:`RMSD<section_example_oechem_rmsd>`
        - aligning multiconformer molecules

.. _section_example_oechem_sdf_specific:

SDF Specific
================================================================================

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`sdfmodprops<section_example_oechem_sdfmodprops>`
        - modifying SD tags
      * - :ref:`sdf2csv<section_example_oechem_sdf2csv>`
        - exporting SD data to a CSV file
      * - :ref:`csv2sdf<section_example_oechem_csv2sdf>`
        - adding CSV data as SD tags
      * - :ref:`sdfrename<section_example_oechem_sdfrename>`
        - renaming molecules by SD field
      * - :ref:`sdfilter<section_example_oechem_sdfilter>`
        - filtering molecules by SD data

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`sdfmodprops.py<section_example_oechem_sdfmodprops>`
        - modifying SD tags
      * - :ref:`sdf2csv.py<section_example_oechem_sdf2csv>`
        - exporting SD data to a CSV file
      * - :ref:`csv2sdf.py<section_example_oechem_csv2sdf>`
        - adding CSV data as SD tags
      * - :ref:`sdfrename.py<section_example_oechem_sdfrename>`
        - renaming molecules by SD field
      * - :ref:`sdfilter.py<section_example_oechem_sdfilter>`
        - filtering molecules by SD data

.. oe:language:: java csharp

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`SDFModProps<section_example_oechem_sdfmodprops>`
        - modifying SD tags
      * - :ref:`SDF2CSV<section_example_oechem_sdf2csv>`
        - exporting SD data to a CSV file
      * - :ref:`CSV2SDF<section_example_oechem_CSV2SDF>`
        - adding CSV data as SD tags
      * - :ref:`sdfrename<section_example_oechem_sdfrename>`
        - renaming molecules by SD field
      * - :ref:`sdfilter<section_example_oechem_sdfilter>`
        - filtering molecules by SD data


Molecule Information Examples
================================================================================

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`molcount<section_example_oechem_molcount>`
        - counting molecules
      * - :ref:`gettitles<section_example_oechem_gettitles>`
        - getting molecule titles
      * - :ref:`molstats<section_example_oechem_molstats>`
        - printing simple molecule information
      * - :ref:`rotorcount<section_example_oechem_rotorcount>`
        - printing rotor count distribution
      * - :ref:`minpath<section_example_oechem_minpath>`
        - finding minimum path in a molecule
      * - :ref:`printatomnames<section_example_oechem_printatomnames>`
        - printing molecule atom names

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`molcount.py<section_example_oechem_molcount>`
        - counting molecules
      * - :ref:`gettitles.py<section_example_oechem_gettitles>`
        - get molecule titles
      * - :ref:`molstats.py<section_example_oechem_molstats>`
        - printing simple molecule information
      * - :ref:`rotorcount.py<section_example_oechem_rotorcount>`
        - printing rotor count distribution
      * - :ref:`minpath.py<section_example_oechem_minpath>`
        - finding minimum path in a molecule
      * - :ref:`printatomnames.py<section_example_oechem_printatomnames>`
        - printing molecule atom names

.. oe:language:: java csharp

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`MolCount<section_example_oechem_molcount>`
        - counting molecules
      * - :ref:`GetTitles<section_example_oechem_gettitles>`
        - get molecule titles
      * - :ref:`MolStats<section_example_oechem_molstats>`
        - printing simple molecule information
      * - :ref:`RotorCount<section_example_oechem_rotorcount>`
        - printing rotor count distribution
      * - :ref:`MinPath<section_example_oechem_minpath>`
        - finding minimum path in a molecule
      * - :ref:`PrintAtomNames<section_example_oechem_printatomnames>`
        - printing molecule atom names

.. _section_example_oechem_2D_coordinate_generation:

2D Coordinate Generation Examples
================================================================================

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`extractringtemplates<section_example_oechem_extractringtemplates>`
        - extracting 2D ring templates
      * - :ref:`createringdict<section_example_oechem_createringdict>`
        - creating 2D ring dictionary
      * - :ref:`appendringdict<section_example_oechem_appendringdict>`
        - appending 2D ring dictionary
      * - :ref:`generate2D<section_example_oechem_generate2D>`
        - generating 2D coordinates

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`extractringtemplates.py<section_example_oechem_extractringtemplates>`
        - extracting 2D ring templates
      * - :ref:`createringdict.py<section_example_oechem_createringdict>`
        - creating 2D ring dictionary
      * - :ref:`appendringdict.py<section_example_oechem_appendringdict>`
        - appending 2D ring dictionary
      * - :ref:`generate2D.py<section_example_oechem_generate2D>`
        - generating 2D coordinates

.. oe:language:: java csharp

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`ExtractRingTemplates<section_example_oechem_extractringtemplates>`
        - extracting 2D ring templates
      * - :ref:`CreateRingDict<section_example_oechem_createringdict>`
        - creating 2D ring dictionary
      * - :ref:`AppendRingDict<section_example_oechem_appendringdict>`
        - appending 2D ring dictionary
      * - :ref:`Generate2D<section_example_oechem_generate2D>`
        - generating 2D coordinates


3D Molecule Styling Examples
================================================================================

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`basicStyle<section_example_oechem_basicmolstyle>`
        - applies a basic :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` to molecules 
      * - :ref:`bFactorStyle<section_example_oechem_bFactorStyle>`
        - applies an :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` that focuses on B-Factor to molecules
      * - :ref:`styleHierarchy<section_oechem_example_stylehierarchy>`
        - applies multiple :ref:`OE3DMolStyles <OEChem_OE3DMolStyle>` to molecules, displaying the hierarchy between the different :ref:`OE3DMolStyles <OEChem_OE3DMolStyle>` applied to the molecule, conformers, and atoms

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`basicStyle.py<section_example_oechem_basicmolstyle>`
        - applies a basic :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` to molecules
      * - :ref:`bFactorStyle.py<section_example_oechem_bFactorStyle>`
        - applies an :ref:`OE3DMolStyle <OEChem_OE3DMolStyle>` that focuses on B-Factor to molecules
      * - :ref:`styleHierarchy.py<section_oechem_example_stylehierarchy>`
        - applies multiple :ref:`OE3DMolStyles <OEChem_OE3DMolStyle>` to molecules, displaying the hierarchy between the different :ref:`OE3DMolStyles <OEChem_OE3DMolStyle>` applied to the molecule, conformers, and atoms


Miscellaneous Examples
================================================================================

.. oe:language:: c++

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`oecheminfo<section_example_oechem_oecheminfo>`
        - printing OEChem and format information
      * - :ref:`anisou<section_example_oechem_anisou>`
        - printing anisotropic B-factors
      * - :ref:`dots<section_example_oechem_dots>`
        - printing dots
      * - :ref:`options<section_example_oechem_options>`
        - defining parameters

.. oe:language:: python

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`oecheminfo.py<section_example_oechem_oecheminfo>`
        - printing OEChem and format information
      * - :ref:`anisou.py<section_example_oechem_anisou>`
        - printing anisotropic B-factors
      * - :ref:`dots.py<section_example_oechem_dots>`
        - printing dots
      * - :ref:`oecifdata<section_example_oechem_cifdata>`
        - using OECIFData
      * - :ref:`setchemcomp.py<section_example_oechem_setchemcomp>`
        - setting CIF _chem_comp data
      * - :ref:`options<section_example_oechem_options>`
        - defining parameters

.. oe:language:: java csharp

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`OEChemInfo<section_example_oechem_oecheminfo>`
        - printing OEChem and format information
      * - :ref:`Anisou<section_example_oechem_anisou>`
        - printing anisotropic B-factors
      * - :ref:`Dots<section_example_oechem_dots>`
        - printing dots
      * - :ref:`Options<section_example_oechem_options>`
        - defining parameters

**Examples**

.. toctree::
   :maxdepth: 1

   oechem_examples/oechem_example_convert
   oechem_examples/oechem_example_catmols
   oechem_examples/oechem_example_parts2mols
   oechem_examples/oechem_example_molextract
   oechem_examples/oechem_example_uniqmol
   oechem_examples/oechem_example_uniqinchi
   oechem_examples/oechem_example_randomizeatoms
   oechem_examples/oechem_example_cansmi
   oechem_examples/oechem_example_sizefilter
   oechem_examples/oechem_example_stripsalts
   oechem_examples/oechem_example_ringsubset
   oechem_examples/oechem_example_extractscaffold
   oechem_examples/oechem_example_randomsample
   oechem_examples/oechem_example_molchunk
   oechem_examples/oechem_example_unimolrxn
   oechem_examples/oechem_example_libgen
   oechem_examples/oechem_example_molgrep
   oechem_examples/oechem_example_makefastss
   oechem_examples/oechem_example_searchfastss
   oechem_examples/oechem_example_mcs3dalign
   oechem_examples/oechem_example_cliquealign
   oechem_examples/oechem_example_smartsalign
   oechem_examples/oechem_example_rmsd
   oechem_examples/oechem_example_sdfmodprops
   oechem_examples/oechem_example_sdf2csv
   oechem_examples/oechem_example_csv2sdf
   oechem_examples/oechem_example_sdfrename
   oechem_examples/oechem_example_sdfilter
   oechem_examples/oechem_example_oecheminfo
   oechem_examples/oechem_example_molcount
   oechem_examples/oechem_example_gettitles
   oechem_examples/oechem_example_molstats
   oechem_examples/oechem_example_rotorcount
   oechem_examples/oechem_example_minpath
   oechem_examples/oechem_example_printatomnames
   oechem_examples/oechem_example_extractringtemplates
   oechem_examples/oechem_example_createringdict
   oechem_examples/oechem_example_appendringdict
   oechem_examples/oechem_example_generate2D
   oechem_examples/oechem_example_anisou
   oechem_examples/oechem_example_dots
   oechem_examples/oechem_example_options
   oechem_examples/oechem_example_basicmolstyle
   oechem_examples/oechem_example_bfactorSty
   oechem_examples/oechem_example_stylehierarchy
   oechem_examples/oechem_example_cifdata
   oechem_examples/oechem_example_setchemcomp