File: api.rst

package info (click to toggle)
propka 3.5.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,888 kB
  • sloc: python: 7,156; makefile: 39
file content (78 lines) | stat: -rw-r--r-- 1,128 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
.. -*- coding: utf-8 -*-

===============
 API Reference
===============

The :program:`propka3` command provides a command-line interface to
PROPKA 3's functionality. It is built on classes and functions in the
:mod:`propka` module. The API of :mod:`propka` is documented here for
developers who might want to directly use the PROPKA 3 code.

.. Note::

   The API is still changing and there is currently no guarantee that
   it will remain stable between minor releases.



.. currentmodule:: propka

.. module:: propka		   


Data structures
===============

.. autosummary::
   :toctree: api
      
   atom
   bonds
   group   
   conformation_container
   molecular_container

   
I/O
===

.. autosummary::
   :toctree: api

   input
   lib
   output
   parameters
   hybrid36
   ligand_pka_values
   run
   version
   
   
Structure processing
====================

.. autosummary::
   :toctree: api

   protonate
   hydrogens	     
   ligand

	     
Calculations
============

.. autosummary::
   :toctree: api

   calculations
   coupled_groups
   determinant
   determinants
   energy
   iterative
   vector_algebra