pyKVFinder Logo

Python Package

  • Installation
  • Tutorial
  • API Reference
    • Functions
      • pyKVFinder.run_workflow
      • pyKVFinder.read_vdw
      • pyKVFinder.read_pdb
      • pyKVFinder.read_xyz
      • pyKVFinder.read_cavity
      • pyKVFinder.get_vertices
      • pyKVFinder.get_vertices_from_file
      • pyKVFinder.detect
      • pyKVFinder.spatial
      • pyKVFinder.depth
      • pyKVFinder.openings
      • pyKVFinder.hydropathy
      • pyKVFinder.constitutional
      • pyKVFinder.calculate_frequencies
      • pyKVFinder.plot_frequencies
      • pyKVFinder.export
      • pyKVFinder.export_openings
      • pyKVFinder.write_results
    • Classes
      • pyKVFinder.Molecule
      • pyKVFinder.pyKVFinderResults
    • Configuration Files
      • Van der Waals radii file template
      • Box configuration file template
      • Hydrophobicity scale file template
  • Examples
  • GitHub repository

Plugins

  • Command-line interface
  • PyMOL pyKVFinder Tools
  • ChimeraX

About

  • KVFinder suite
  • Scientific team
  • Citing pyKVFinder
  • Issues
  • Funding
  • License
pyKVFinder
  • API Reference
  • View page source

API Reference

The API of all pyKVFinder functions, classes and configuration files with expected types and all parameters available.

Functions

  • pyKVFinder.run_workflow
  • pyKVFinder.read_vdw
  • pyKVFinder.read_pdb
  • pyKVFinder.read_xyz
  • pyKVFinder.read_cavity
  • pyKVFinder.get_vertices
  • pyKVFinder.get_vertices_from_file
  • pyKVFinder.detect
  • pyKVFinder.spatial
  • pyKVFinder.depth
  • pyKVFinder.openings
  • pyKVFinder.hydropathy
  • pyKVFinder.constitutional
  • pyKVFinder.calculate_frequencies
  • pyKVFinder.plot_frequencies
  • pyKVFinder.export
  • pyKVFinder.export_openings
  • pyKVFinder.write_results

Classes

  • pyKVFinder.Molecule
  • pyKVFinder.pyKVFinderResults

Configuration Files

  • Van der Waals radii file template
  • Box configuration file template
  • Hydrophobicity scale file template
Previous Next

© Copyright 2021, LBC-LNBio.

Built with Sphinx using a theme provided by Read the Docs.