Skip to main content

Python API for cpptraj: a data analysis package for biomolecular simulation

Project description

[![Build Status](https://travis-ci.org/Amber-MD/pytraj.svg?branch=master)](https://travis-ci.org/Amber-MD/pytraj)
[![Binstar Badge](https://anaconda.org/ambermd/pytraj/badges/version.svg)](https://anaconda.org/ambermd/pytraj/)
[![PyPI version](https://badge.fury.io/py/pytraj.svg)](https://badge.fury.io/py/pytraj)
[![Coverage Status](https://coveralls.io/repos/Amber-MD/pytraj/badge.svg?branch=master&service=github)](https://coveralls.io/github/Amber-MD/pytraj?branch=master)
[![Binder](http://mybinder.org/images/logo.svg)](http://mybinder.org/repo/hainm/notebook-pytraj)

[![pytraj website](./examples/figures/pytraj.gif)](http://amber-md.github.io/pytraj/latest/index.html)

PYTRAJ
------
A Python front-end of [cpptraj program] (https://github.com/Amber-MD/cpptraj) (a data analysis package for biomolecular simulation).

Website: http://amber-md.github.io/pytraj

* [Features](#features)
* [Install](#install)
* [How to get started?](#how-to-get-started)
* [Contributors and Acknowledgement](#contributors-and-acknowledgement)
* [Citation](#citation)
* [Question/Suggestion?](#questionsuggestion)
* [nglview with pytraj in Jupyter notebook](#nglview-with-pytraj-in-jupyter-notebook)
* [Demo: Interactive data exploration with Jupyter notebook](#demo-interactive-data-exploration-with-jupyter-notebook)
* [License](#license)


Features
--------

- support more than 80 types of data analyses (rmsd, radgyr, autoimage, pca, clustering,...)
- read/write various file formats (.nc, .dcd, .trr, .pdb, .mol2, ...)
- fast (core codes were written in C++ and Cython)
- support parallel calculation with trivial installation (openmp, multiprocessing, mpi, ...)
- interactive analysis with large trajectory data that does not fit to memory
- [>> many more with comprehensive tutorials] (http://amber-md.github.io/pytraj)


Install
-------
Supported platforms: Linux, OSX

- from AMBER suite distribution [http://ambermd.org/](http://ambermd.org/#AmberTools).

- from conda: `conda install -c ambermd pytraj`

- from pip: `pip install pytraj`

- from source code:

```bash
git clone https://github.com/amber-md/pytraj
cd pytraj

python setup.py install

# Note: openmp will be turned off in OSX.
```

- getting trouble? : [check our webpage](http://amber-md.github.io/pytraj/latest/installation.html)


How to get started?
------------------

- examples:

```python
import pytraj as pt
traj = pt.iterload("data.nc", "top.parm7")
pt.rmsd(traj, mask='@CA', ref=0)
pt.dssp(traj, mask=':2-16')
pt.pca(traj, mask='!@H=', n_vecs=2)
```
- check our website: [http://amber-md.github.io/pytraj] (http://amber-md.github.io/pytraj)

Contributors and Acknowledgement
--------------------------------

[Please check here](./contributors/)

Citation
--------

If you would like to acknowledge our work, please cite both ``cpptraj`` and ``pytraj`` papers.

something like:

"...used pytraj [1], a Python package binding to cpptraj program [2]"

- [1] PYTRAJ: Interactive data analysis for molecular dynamics simulations. Hai Nguyen, Daniel R. Roe, Jason Swails, David A. Case. (2016)

- [2] [PTRAJ and CPPTRAJ] (http://pubs.acs.org/doi/abs/10.1021/ct400341p): Software for Processing and Analysis of Molecular Dynamics Trajectory Data.
Daniel R. Roe and Thomas E. Cheatham, III
Journal of Chemical Theory and Computation 2013 9 (7), 3084-3095


Question/Suggestion?
--------------------
* code issue and stuff relating directly to `pytraj`, create [Issue](https://github.com/pytraj/pytraj/issues)
* ask question about data analysis in general, send email to [AMBER Mailing List] (http://lists.ambermd.org/mailman/listinfo/amber)

[nglview](https://github.com/arose/nglview) with pytraj in Jupyter notebook
---------------------------------------


Demo: Interactive data exploration with [Jupyter notebook] (http://jupyter.org/)
--------------------------------------------------------------------------------

[![pytraj website](./examples/progress_bar.gif)](http://amber-md.github.io/pytraj/latest/index.html)


License
-------
GPL v3 (since pytraj is derived work of [cpptraj](https://github.com/Amber-MD/cpptraj/blob/master/LICENSE))

But if you would like to reuse code snippets and pieces independent of cpptraj, I am (Hai) happy to license them (pieces of codes) under
BSD-2 Clause or whatever you like. Just buzz us.

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

pytraj-1.0.7.tar.gz (36.4 MB view details)

Uploaded Source

Built Distributions

pytraj-1.0.7-cp35-cp35m-manylinux1_x86_64.whl (17.4 MB view details)

Uploaded CPython 3.5m

pytraj-1.0.7-cp35-cp35m-macosx_10_5_x86_64.whl (5.6 MB view details)

Uploaded CPython 3.5mmacOS 10.5+ x86-64

pytraj-1.0.7-cp34-cp34m-manylinux1_x86_64.whl (17.5 MB view details)

Uploaded CPython 3.4m

pytraj-1.0.7-cp34-cp34m-macosx_10_5_x86_64.whl (5.6 MB view details)

Uploaded CPython 3.4mmacOS 10.5+ x86-64

pytraj-1.0.7-cp27-cp27mu-manylinux1_x86_64.whl (17.0 MB view details)

Uploaded CPython 2.7mu

pytraj-1.0.7-cp27-cp27m-macosx_10_5_x86_64.whl (5.5 MB view details)

Uploaded CPython 2.7mmacOS 10.5+ x86-64

File details

Details for the file pytraj-1.0.7.tar.gz.

File metadata

  • Download URL: pytraj-1.0.7.tar.gz
  • Upload date:
  • Size: 36.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pytraj-1.0.7.tar.gz
Algorithm Hash digest
SHA256 9188e28e7c96f0657a8d5dbf79aa565d12c3a851854747a77e6448ddd6e374d4
MD5 e6aad2466c7e0252f37a4aec1f61f9e6
BLAKE2b-256 cf7b33256bbb7f6747f1ea1a35f71bca623e426747d269a0e982639ed9ec7279

See more details on using hashes here.

File details

Details for the file pytraj-1.0.7-cp35-cp35m-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for pytraj-1.0.7-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 2479b40238f466140cbd526d52c448d5feb97b8b85a628820baa3346c912afdf
MD5 83747172c01227d5a0b8a56b53951472
BLAKE2b-256 30ac9f3b10258f66f1745854b199ecbce6907ac7fa9c04aad67b7f0caa49f9d4

See more details on using hashes here.

File details

Details for the file pytraj-1.0.7-cp35-cp35m-macosx_10_5_x86_64.whl.

File metadata

File hashes

Hashes for pytraj-1.0.7-cp35-cp35m-macosx_10_5_x86_64.whl
Algorithm Hash digest
SHA256 80db57ea38dd1d5e3f973616fd9cadb07c9e84b167f0dcfa1016bae25b6121a3
MD5 36a5379f902ec91280a50fd68f1844de
BLAKE2b-256 74f45131eb64a4220d9526c4dacfb6d29d99256f27a053e5a7ed133c376226ad

See more details on using hashes here.

File details

Details for the file pytraj-1.0.7-cp34-cp34m-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for pytraj-1.0.7-cp34-cp34m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 04f1d136c7ca83e677595eee22a15727e42ead5f92e9b55e389215e2a16411a9
MD5 2684de69f97cbe99f2e9adb68eb34e53
BLAKE2b-256 8ccb7b79d8d1d37014c2761765bc41e3629c5dab0830d12df3c9ad7dc2178db9

See more details on using hashes here.

File details

Details for the file pytraj-1.0.7-cp34-cp34m-macosx_10_5_x86_64.whl.

File metadata

File hashes

Hashes for pytraj-1.0.7-cp34-cp34m-macosx_10_5_x86_64.whl
Algorithm Hash digest
SHA256 774f48b44b3ea7326bd217af68f298bc91e7b65bb752f47266a6960869ff31ec
MD5 20ce08078f9c959883f83a8cbf0188dc
BLAKE2b-256 d20d276fcfe8acf56fdf99018a675423e0f0ca8e0484e826324f1de3652c82c5

See more details on using hashes here.

File details

Details for the file pytraj-1.0.7-cp27-cp27mu-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for pytraj-1.0.7-cp27-cp27mu-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 bcd41212720f60268b37c17c20664966a48f8913e11c3fd6c912211046743b2c
MD5 7b29ddb30eb200208672cec2a8a31a87
BLAKE2b-256 412868d927e5d705ed40cf793da313b73a3328737f2d8addffa8a64c91257ba4

See more details on using hashes here.

File details

Details for the file pytraj-1.0.7-cp27-cp27m-macosx_10_5_x86_64.whl.

File metadata

File hashes

Hashes for pytraj-1.0.7-cp27-cp27m-macosx_10_5_x86_64.whl
Algorithm Hash digest
SHA256 fa330cd32f3463967fae6f2519520ce6d0d7718905b8bcd59de0dc21db16fb10
MD5 363f90978d7a855fa6c8aeefa6e4aeb7
BLAKE2b-256 b59a8ff8181d7e8fa938cba056ecb43cc44f4febec929d96d9aae7aa5b059e7d

See more details on using hashes here.

Supported by

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