This document is for OpenStructure version 1.10, the latest version is 2.9.0 !

naccess - Calculate accessible area of a molecule

CalculateSurfaceArea(entity, radius=1.4, include_hydrogens=False, include_hetatm=False, include_water=False, selection='', naccess_exe=None, naccess_root=None, keep_files=False, asa_abs='asaAbs', asa_rel='asaRel', asa_atom='asaAtom', scratch_dir=None, max_number_of_atoms=50000)

Calculates analytical the solvent accessible surface area by using the external naccess program

This method calculates the molecular surface areas by invoking the external program naccess. First, it is checked if the naccess executable is present, then, the necessary files are prepared in a temporary directory and naccess is executed. The last step is to remove the temporary directory.

Parameters:
  • entity – OST entity to calculate surface
  • radius – Surface probe radius
  • include_hydrogens – Calculate surface including hydrogens
  • include_hetatm – Calculate surface including hetatms
  • include_water – Calculate surface including water
  • selection – Calculate surface for subset of entity
  • naccess_exe – naccess executable (full path to executable)
  • naccess_root – Path to folder containing “accall” binary and files “vdw.radii” and “standard.data”. This is the fastest way to call naccess!
  • keep_files – If True, do not delete temporary files
  • asa_abs – Attaches per residue absolute SASA to specified FloatProp on residue level
  • asa_rel – Attaches per residue relative SASA to specified FloatProp on residue level
  • asa_atom – Attaches per atom SASA to specified FloatProp at atom level
  • scratch_dir – Scratch directory. A subfolder for temporary files is created in there. If not specified, a default directory is used (see tempfile.mkdtemp()).
  • max_number_of_atoms – Max Number of atoms in the entity (i.e. is limited in the default NACCESS version to 50 000)
Returns:

absolute SASA calculated using asa_atom

Search

Enter search terms or a module, class or function name.

Contents

Documentation is available for the following OpenStructure versions:

dev / 2.9.0 / 2.8 / 2.7 / 2.6 / 2.5 / 2.4 / 2.3.1 / 2.3 / 2.2 / 2.1 / 2.0 / 1.9 / 1.8 / 1.7.1 / 1.7 / 1.6 / 1.5 / 1.4 / 1.3 / 1.2 / 1.11 / (Currently viewing 1.10) / 1.1

This documentation is still under heavy development!
If something is missing or if you need the C++ API description in doxygen style, check our old documentation for further information.