Skip to main content

Automated CG-to-AA workflow for protein condensate simulations

Project description

CondenSimAdapter

CondenSimAdapter is an automated workflow for protein condensate simulations, covering the main stages from coarse-grained (CG) to all-atom (AA).

Installation

Quick Start

# 1. Create a conda environment
conda create -n conden python=3.11 -y
conda activate conden

# 2. Install from PyPI
pip install CondenSimAdapter

# 3. Verify installation
adapter --version

Installation Options

Standard Installation (recommended)

pip install CondenSimAdapter

Includes all core functionality: OpenMM, MDAnalysis, mdtraj, and other simulation tools.

With Machine Learning (optional)

For neural network backmapping (requires CUDA-matched PyTorch):

pip install "CondenSimAdapter[ml]"

This includes PyTorch, DGL, and e3nn for CG-to-AA backmapping.

Development Installation

If you want to modify the source code:

git clone https://github.com/hanlab-computChem/CondenSimAdapter.git
cd CondenSimAdapter
pip install -e ".[dev]"

Testing

# Run tests
pytest tests/

# Run with coverage
pytest tests/ --cov=CondenSimAdapter

Usage

Command Line Interface

# Show help
adapter --help

# Run backmapping
adapter backmap -c cg_structure.pdb -o aa_structure.pdb

# Check model status
adapter models status

Python API

from CondenSimAdapter import backmap

# Backmap CG structure to AA
backmap.convert("cg_input.pdb", "aa_output.pdb")

Requirements

  • Python >= 3.10, < 3.12 (3.11 recommended)
  • CUDA >= 12.1 (for ML features)
  • GROMACS >= 2023 (install separately)

Links

License

GPL-3.0

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

condensimadapter-1.0.0b2.tar.gz (2.5 MB view details)

Uploaded Source

Built Distribution

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

condensimadapter-1.0.0b2-py3-none-any.whl (2.7 MB view details)

Uploaded Python 3

File details

Details for the file condensimadapter-1.0.0b2.tar.gz.

File metadata

  • Download URL: condensimadapter-1.0.0b2.tar.gz
  • Upload date:
  • Size: 2.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.4

File hashes

Hashes for condensimadapter-1.0.0b2.tar.gz
Algorithm Hash digest
SHA256 2da77645d44dab737dfd90d551d22b0d8ce1a8e2146a6cd7d623362c2cbd801f
MD5 efdfa04b95e58a174124f5150c4bc9b2
BLAKE2b-256 492d0fba8790483344778be7de848531f617505ae910d58fcdce51a61b2ef3e8

See more details on using hashes here.

File details

Details for the file condensimadapter-1.0.0b2-py3-none-any.whl.

File metadata

File hashes

Hashes for condensimadapter-1.0.0b2-py3-none-any.whl
Algorithm Hash digest
SHA256 cb83369a5a6bc492cdc53d2b5df8605c02ddde79bbc1a19562651738fd55e6c7
MD5 dcb2a1626721654652a872c6d141cf25
BLAKE2b-256 b73066c8a90f35cc7b29d6ca889daf6b7f38542c1037e15bc52d00afa8ff4a95

See more details on using hashes here.

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