Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AntonOresten authored Nov 7, 2024
1 parent a0bae1f commit 3c38937
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The package is registered in the General registry, and can be installed from the

## Usage

The `assign_secondary_structure` function takes a vector of atom coordinate arrays of size (3, 3, L). The first axis is for the x, y, and z coordinates, the second axis is for the atom types (N, CA, C), and the third axis is for the residues.
The `assign_secondary_structure` function takes a vector of atom coordinate arrays of size `(3, 3, L)`. The first axis is for the x, y, and z coordinates, the second axis is for the atom types (N, CA, C), and the third axis is for the residues.

```julia
julia> using BioStructures
Expand All @@ -32,6 +32,11 @@ julia> assign_secondary_structure(coords_vector) # 2 chains
[1, 1, 1, 1, 3, 3, 3, 3, 3, 3 2, 2, 2, 2, 2, 2, 2, 1, 1, 1]
```

The output is vectors of integers:
- `1`: loop
- `2`: helix
- `3`: strand

## Acknowledgements

This package was originally ported from the [PyDSSP](https://github.com/ShintaroMinami/PyDSSP) package, created by Shintaro Minami. The code has since been rewritten to look more like the 1983 paper (Kabsch W and Sander C), and to be more Julian, understandable, and efficient, at the cost of it no longer being differentiable like the PyDSSP version. The time complexity is still quadratic, so it may be slow for larger proteins. We plan on making a more efficient version with k-d trees.

0 comments on commit 3c38937

Please sign in to comment.