Skip to content

Commit

Permalink
Add docstring for structure.alphabet subpackage
Browse files Browse the repository at this point in the history
  • Loading branch information
padix-key committed Nov 2, 2024
1 parent ec8ed77 commit 226d7fb
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions src/biotite/structure/alphabet/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,18 @@

"""
A subpackage for converting structures to structural alphabet sequences.
Structural alphabets represent the local geometry of each residue in a structure as
symbol in a sequence.
This allows using sequence-based functionality from :mod:`biotite.sequence` on
structural data.
For each supported structural alphabet, this subpackage provides a conversion function
that converts each chain of a given structure into a :class:`Sequence` object from the
respective structural alphabet.
Note that the structural alphabets use lower-case letters as symbols, in order to
distinguish them better from the nucleotide and amino acid alphabets.
"""

__name__ = "biotite.structure.alphabet"
Expand Down

0 comments on commit 226d7fb

Please sign in to comment.