SAXSMART: SAXS Modelling and Refinement Toolkit
Overview
SAXSMART is an interactive web application for the analysis and refinement of Small-Angle X-ray Scattering (SAXS) data. It provides a user-friendly interface to perform common SAXS analyses and refine structural models against experimental data using PEPSI-SAXS.
Features
- Data Upload: Upload SAXS curves (.dat), protein sequences (.fasta), and structures (.pdb/.cif).
- Database Fetch: Fetch structural models directly from the PDB or AlphaFold Database.
- Automated Analysis: Automatic calculation of Guinier fit, P(r) distribution, and Kratky plots.
- Interactive Refinement: Integrated PEPSI-SAXS for rigid-body and flexible model refinement.
- Rich Visualization: Interactive plots and 3D molecular viewers.
Installation
From Pypi
# Create and activate a virtual environment (or use conda)
python3 -m venv .venv
source .venv/bin/activate
# Install
pip install -e saxsmart
From source
# Clone your repository
git clone https://gitlab.esrf.fr/hayden5a/saxsmart.git
cd saxsmart
# Create and activate a virtual environment (or use conda)
python3 -m venv .venv
source .venv/bin/activate
# Install
python -m pip install -U pip
pip install -e .
Note: Dependencies are declared in
pyproject.toml.
Running
After installation, use the console script:
saxsmart
Alternative entry points:
python -m saxsmart
- Dash automatically serves files in the packaged
assets/directory. - Example data is bundled under
saxsmart/example_data/.
Configuration
You can configure paths via environment variables:
PEPSI_SAXS_BIN— Full path to thepepsi-SAXSexecutable (if not onPATH).export PEPSI_SAXS_BIN=/opt/pepsi/pepsi-SAXS
SAXSMART_CACHE_DIR— Override the directory for long-callback caching.export SAXSMART_CACHE_DIR=/scratch/$USER/saxsmart-cache
SAXSMART_TEMP— Override the temporary working directory.export SAXSMART_TEMP=/scratch/$USER/saxsmart-tmp
If
PEPSI-SAXSis not required for your workflow, related actions will be disabled or produce a friendly error message.
License
MIT (see LICENSE).
Metadata
Release files for saxsmart 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| saxsmart-1.0.0.tar.gz | 166.8 kB | Without provenance | Details for saxsmart-1.0.0.tar.gz |
Release files / saxsmart-1.0.0.tar.gz
| Download URL | saxsmart-1.0.0.tar.gz |
|---|---|
| Size | 166.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
23885ad7b83e36d8d099540d4d5e002f106eb266cecef86840c64b6dc1a5b333
|
|
BLAKE2b-256 checksum How to use checksums |
e8e77194903c49ab85ed7cfc82c95aaba5b213dfef509a043d5e2d569d00c44f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.10
|
Security for saxsmart 1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.