RustSASA

⚡ Ludicrously fast Rust crate for protein solvent accessible surface area (SASA) calculations - 63x faster than Biopython, 5x faster than FreeSASA. Pure Rust with Python bindings & CLI. Implements Shrake-Rupley algorithm [1].

Features:

• 🦀 Written in Pure Rust.
• ⚡️ Ludicrously fast. 63X faster than Biopython, 14X faster than mdakit_sasa, and 5X faster than Freesasa.
• 🧪 Full test coverage.
• 🐍 Python support.
• 🤖 Command line interface.

Table of Contents

• Features
• Installation
• Quick start
  • Rust
  • Python
  • CLI
  • MDAnalysis
• Benchmarks
• Validation
• Contributing
• License
• How to cite

Installation

Rust 🦀

cargo add rust-sasa

Python 🐍

pip install rust-sasa-python

MDAnalysis package

pip install mdsasa-bolt

Command-line interface 🤖

1. Install Cargo Bin Install

curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash

2. Install rust-sasa

cargo binstall rust-sasa

Quick start

Using in Rust 🦀

use pdbtbx::StrictnessLevel;
use rust_sasa::options::{SASAOptions, ResidueLevel};

let (mut pdb, _errors) = pdbtbx::open("./example.cif").unwrap();
let result = SASAOptions::<ResidueLevel>::new().process(&pdb);

Full documentation can be found here.

Using in Python 🐍

You can now utilize RustSasa within Python to speed up your scripts! Take a look at rust-sasa-python!

import rust_sasa_python as sasa

# Simple calculation - use convenience function
result = sasa.calculate_protein_sasa("protein.pdb")
print(f"Total SASA: {result.total:.2f}")

See full docs here.

Using CLI 🤖

Processing single file

rust-sasa path_to_pdb_file.pdb output.json # Also supports .xml, .pdb, and .cif!

Processing an entire directory

rust-sasa input_directory/ output_directory/ --format json # Also supports .xml, .pdb, and .cif!

Using with MDAnalysis

RustSASA can be used with MDAnalysis to calculate SASA for a protein in a trajectory. RustSASA is 17x faster than mdakit_sasa.

import MDAnalysis as mda
from mdsasa_bolt import SASAAnalysis

# Load your trajectory
u = mda.Universe("topology.pdb", "trajectory.dcd")

# Create SASA analysis
sasa_analysis = SASAAnalysis(u, select="protein")

# Run the analysis
sasa_analysis.run()

# Access results
print(f"Mean total SASA: {sasa_analysis.results.mean_total_area:.2f} Ų")
print(f"SASA per frame: {sasa_analysis.results.total_area}")
print(f"SASA per residue: {sasa_analysis.results.residue_area}")

See the mdsasa-bolt package for more information.

Benchmarking

Results:

• RustSasa: 5.237 s ± 0.049 s

• Freesasa: 28.042 s ± 2.269 s

• Biopython: 368.025 s ± 51.156 s

Methodology:

We computed residue level SASA values for the entire AlphaFold E. coli proteome structure database using RustSASA, Freesasa, and Biopython. Benchmarks were run with Hyperfine with options: --warmup 3 --runs 3. All three methods ran across 8 cores on an Apple M3 Macbook with 24GB of unified memory. The RustSASA CLI was used to take advantage of profile guided optimization. GNU Parallel was used to run Freesasa and Biopython in parallel.

Validation against Freesasa

Other

License

MIT

Version 0.7.0 (Latest update)

• RustSASA now excludes HETATM records (non-standard amino acids and ligands) by default. This can be overridden by passing --include-hetatoms (or API equivalent).
• Improved CLI error reporting and handling.
• Added support for customizing number of threads used for parallelization. This can be done via --threads (or API equivalent).
• RustSASA now throws an error if an atom is not found in the provided/default radii config. This error can be ignored via --allow-vdw-fallback (or API equivalent).
• Paper updated to include single-threaded RustSASA benchmark among other changes.

Building from source

First, make sure you have the Rust compiler installed. See https://rust-lang.org/tools/install/ for installation instructions.

To build RustSASA from source start by initializing git submodules with the following command:

git submodule update --init

Then build the binary with:

cargo build --release

Contributing

Contributions are welcome! Please feel free to submit pull requests and open issues. As this is an actively developed library, I encourage sharing your thoughts, ideas, suggestions, and feedback.

Hydrogen & Non-standard amino acid handling

By default, RustSASA strips hydrogen atoms and uses the ProtOr radii config. If you want to include hydrogens, you can use the CLI argument --include-hydrogens. If you do so, you should provide your own atom radii config designed to work with hydrogens. Custom radii configs can be provided with --radii-file. --radii-file accepts a Freesasa style .config file see configs here.

Additionally, RustSASA filters HETATM records by default. If you want to include HETATM records, you can use the CLI argument --include-hetatoms or the API equivalent (see docs). If you include HETATMs you will need to provide a custom radii file that specifies radii for the non-standard amino acids/ligands in your input.

How to cite

If you use the RustSASA library in your publication please cite it. To cite this reposity scroll up to the top of this page, and then click on the "Cite this repository" button in the right hand GitHub side bar. This will give you a citation in your desired format (i.e: BiBTeX, APA).

Citations:

1: Shrake A, Rupley JA. Environment and exposure to solvent of protein atoms. Lysozyme and insulin. J Mol Biol. 1973 Sep 15;79(2):351-71. doi: 10.1016/0022-2836(73)90011-9. PMID: 4760134.