.. _spruce_chapter_examples:

*************************
Spruce TK Examples
*************************

The following table lists the currently available **Spruce TK** examples:

.. oe:language:: c++

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

      * - Program
        - Description

      * - :ref:`make_design_units<spruce_examples_make_design_units>`
        - Constructing design units from a PDB (due to loop modeling, this example takes ~10 min)
      * - :ref:`make_apo_design_units<spruce_examples_make_apo_design_units>`
        - Constructing apo design units from a PDB using a site residue input (due to loop modeling, this example takes ~10 min)
      * - :ref:`superposition<spruce_examples_superposition>`
        - Superposition of two proteins
      * - :ref:`extract_biounits_remarks<spruce_examples_extract_biounits_remarks>`
        - Extract biounits from PDB header remarks
      * - :ref:`extract_biounits_ref<spruce_examples_extract_biounits_ref>`
        - Extract biounits from a sequence alignment to a reference protein
      * - :ref:`findpockets<spruce_examples_find_pockets>`
        - Find pockets and some of their properties from a protein or uesign unit
      * - :ref:`convert_du_to_mmcif<spruce_examples_du2mmcif>`
        - Writing DU to MMCIF file
      * - :ref:`write_metadata_json_file<spruce_examples_metadata>`
        - Writing a metadata JSON file from a FASTA file
        

.. oe:language:: python

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

      * - Program
        - Description

      * - :ref:`make_design_units.py<spruce_examples_make_design_units>`
        - Constructing design units from a PDB (due to loop modeling, this example takes ~10 min)
      * - :ref:`make_apo_design_units<spruce_examples_make_apo_design_units>`
        - Constructing apo design units from a PDB using a site residue input (due to loop modeling, this example takes ~10 min)
      * - :ref:`du2mmcif.py <spruce_examples_du2mmcif>`
        - Write an output MMCIF file from a Spruce generated design unit
      * - :ref:`superpose.py<spruce_examples_superposition>`
        - Superposition of two proteins
      * - :ref:`extract_biounits_remarks.py<spruce_examples_extract_biounits_remarks>`
        - Extract biounits from PDB header remarks
      * - :ref:`extract_biounits_ref.py<spruce_examples_extract_biounits_ref>`
        - Extract biounits from a sequence alignment to a reference protein
      * - :ref:`findpockets.py<spruce_examples_find_pockets>`
        - Find pockets and some of its properties from a protein or design unit
      * - :ref:`convert_du_to_mmcif<spruce_examples_du2mmcif>`
        - Writing DU to MMCIF file
      * - :ref:`write_metadata_json_file<spruce_examples_metadata>`
        - Writing a metadata JSON file from a FASTA file
      * - :ref:`validate_design_unit<spruce_examples_validate_design_unit>`
        - Validate structure of the design unit
      * - :ref:`add_receptor_obj_to_du<spruce_examples_add_receptor_to_du>`
        - Add receptor grid to design unit
      * - :ref:`make_design_unit_using_metadata<spruce_examples_make_design_units_using_metadata>`
        - Constructing design units from a PDB using metadata to specify ligand and tautomer state

**Examples:**

.. toctree::
   :maxdepth: 1

   examples_make_design_units
   examples_make_apo_design_units
   examples_du2mmcif
   examples_superposition
   examples_extract_biounits_remarks
   examples_extract_biounits_ref
   examples_find_pockets
   examples_metadata
   examples_validate_design_unit
   examples_add_receptor_to_du
   examples_make_design_unit_with_metadata