From bdf9fa2cdf4b857068f92c6bbf09f1e1d56be834 Mon Sep 17 00:00:00 2001
From: Rafal Gumienny <r.gumienny@unibas.ch>
Date: Thu, 26 Apr 2018 14:45:00 +0200
Subject: [PATCH] docs: SCHWED-3121 Add StereoChemicalProps documentation
---
modules/mol/alg/doc/molalg.rst | 27 +++++++++++++++++++++++++++
1 file changed, 27 insertions(+)
diff --git a/modules/mol/alg/doc/molalg.rst b/modules/mol/alg/doc/molalg.rst
index 237a5c344..550c5d803 100644
--- a/modules/mol/alg/doc/molalg.rst
+++ b/modules/mol/alg/doc/molalg.rst
@@ -465,6 +465,33 @@ Local Distance Test scores (lDDT, DRMSD)
:type structural_checks: bool
:param cutoffs_length: Length of the cutoffs list used for calculations
:type cutoffs_length: int
+
+.. class:: StereoChemicalProps(bond_table, angle_table, nonbonded_table)
+
+ Object containing the stereo-chemical properties read form stereochmical_props.txt
+ file.
+
+ :param bond_table: Sets :attr:`bond_table`
+ :param angle_table: Sets :attr:`angle_table`
+ :param nonbonded_table: Sets :attr:`nonbonded_table`
+
+ .. attribute:: bond_table
+
+ Object containing bond parameters
+
+ :type: :class:`~ost.mol.alg.StereoChemicalParams`
+
+ .. attribute:: angle_table
+
+ Object containing angle parameters
+
+ :type: :class:`~ost.mol.alg.StereoChemicalParams`
+
+ .. attribute:: nonbonded_table
+
+ Object containing clashing distances parameters
+
+ :type: :class:`~ost.mol.alg.ClashingDistances`
.. class:: lDDTSettings(radius=15, \
--
GitLab