Skip to main content

Adaptive sampling on MD trajectories via clustering and policy-driven seed selection

Project description

AdaptivePy

Adaptive sampling for molecular dynamics trajectories

Clustering-based state space partitioning and policy-driven seed selection for MD workflows.

Documentation PyPI Python


Overview

AdaptivePy helps you identify under-sampled regions of conformational space and select seed frames for new simulations. It loads per-trajectory feature arrays, clusters frames, applies adaptive policies, and writes reproducible metadata and optional PDB structures.

Full documentation: https://hnadeem2.github.io/AdaptivePy/

Input Feature arrays (.npy / .pkl), optional coordinate trajectories
Clustering KMeans, MiniBatch KMeans, regular-space
Policies Least counts, random, FAST, MA-REAP (extensible)
Output Seeds, cluster assignments, model, logs, optional PDBs

Installation

pip install adaptivepy-sampling

For development:

git clone https://github.com/hnadeem2/AdaptivePy.git
cd AdaptivePy
pip install -e ".[dev,docs]"

Quick start

  1. Prepare features — one file per trajectory, shape (n_frames, n_features):

    features/
    ├── traj_0.npy
    └── traj_1.pkl
    
  2. Configure — edit examples/config.yaml (or create your own).

  3. Run:

    adaptivepy run examples/config.yaml
    

See the Getting Started guide for a complete walkthrough.

CLI

adaptivepy run config.yaml       # run adaptive sampling
adaptivepy validate config.yaml  # validate inputs only
adaptivepy list-policies         # list available policies

Python API

from adaptivepy import run_adaptive_sampling

results = run_adaptive_sampling("config.yaml")

Documentation

Guide Description
Getting Started First run in minutes
Configuration YAML options and defaults
Feature Inputs File formats and layout
Policies Seed selection strategies
API Reference Module documentation

Contributors

  • Hassan

License

MIT. See LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adaptivepy_sampling-0.2.0.tar.gz (34.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

adaptivepy_sampling-0.2.0-py3-none-any.whl (41.8 kB view details)

Uploaded Python 3

File details

Details for the file adaptivepy_sampling-0.2.0.tar.gz.

File metadata

  • Download URL: adaptivepy_sampling-0.2.0.tar.gz
  • Upload date:
  • Size: 34.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for adaptivepy_sampling-0.2.0.tar.gz
Algorithm Hash digest
SHA256 1de2aec88b933732458f24e00be1bc7bd447643e44d698c50b16d2e42430efe8
MD5 756c2cbcf4372193eecfeaf452fcca53
BLAKE2b-256 441bbc91695cbb5d413e0bc78c51db97d3269e1606860a3a8f9b3c929fd7aa7b

See more details on using hashes here.

Provenance

The following attestation bundles were made for adaptivepy_sampling-0.2.0.tar.gz:

Publisher: publish.yml on hnadeem2/AdaptivePy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file adaptivepy_sampling-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for adaptivepy_sampling-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9bdb0e1c4245a0a032bd5fdc4524866e4bcd5a76470ae424b937e9e2edc462ac
MD5 f7f3d68ef1e91377d2a980f6b4d4c2a0
BLAKE2b-256 e52e4dc72b1fa90eee8f77dce255b7afa33b8e8f6b8b39388914713493d25b35

See more details on using hashes here.

Provenance

The following attestation bundles were made for adaptivepy_sampling-0.2.0-py3-none-any.whl:

Publisher: publish.yml on hnadeem2/AdaptivePy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page