Skip to main content

A command line client for MDAnalysis Analysis classes.

Project description

MDAnalysis command line interface

PyPI Package latest release Powered by MDAnalysis Codecov mdacli Documentation (latest release)

Github Actions Build Status Github Actions Build Status Github Actions Build Status

mdacli is a simple command line interface (CLI) to the analysis classes of MDAnalysis using argparse. This project is in an early development stage and work in progress. Contributions are welcome!

To install mdacli refer to the INSTALL file.

Run mdacli:

mda -h

For a help and an overview of the supported modules. A help message for each module is available using:

mda <module> -h

Available modules

Currently the following analysis modules are available

Module Name

Description

AlignTraj

RMS-align trajectory to a reference structure using a selection.

AverageStructure

RMS-align trajectory to a reference structure using a selection,

Contacts

Calculate contacts based observables.

DensityAnalysis

Volumetric density analysis.

DistanceMatrix

Calculate the pairwise distance between each frame in a trajectory

Janin

Calculate χ_1 and χ_2 dihedral angles of selected group

Ramachandran

Calculate ϕ and ψ dihedral angles of selected group

GNMAnalysis

Basic tool for GNM analysis.

closeContactGNMAnalysis

GNMAnalysis only using close contacts.

HELANAL

Perform HELANAL helix analysis on your trajectory.

HoleAnalysis

Run program hole on a trajectory.

LinearDensity

Linear density profile

EinsteinMSD

Class to calculate Mean Squared Displacement by the Einstein relation.

PCA

Principal component analysis on an MD trajectory.

InterRDF

Intermolecular pair distribution function

RMSD

Class to perform RMSD analysis on a trajectory.

RMSF

Calculate RMSF of given atoms across a trajectory.

More information about each module is available through the help page or at the MDAnalysis documentation.

Changelog

v0.1.5 (2021-12-01)

  • Add doc deployment to CI (#78)

v0.1.4 (2021-11-24)

  • Link docs to mdacli.mdanalysis.org (#75)

v0.1.3 (2021-11-24)

  • MDA-style documentation pages (#70)

v0.1.2 (2021-11-18)

  • Added option to manually set box dimensions (#65)

v0.1.1 (2021-11-18)

  • corrects .bumpversion.cfg for CHANGELOG

  • updates docs/CONTRIBUTING.rst accordingly

v0.1.0 (2021-11-18)

  • Initial release

Download files

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

Source Distribution

mdacli-0.1.5.tar.gz (235.1 kB view details)

Uploaded Source

Built Distribution

mdacli-0.1.5-py3-none-any.whl (35.1 kB view details)

Uploaded Python 3

File details

Details for the file mdacli-0.1.5.tar.gz.

File metadata

  • Download URL: mdacli-0.1.5.tar.gz
  • Upload date:
  • Size: 235.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for mdacli-0.1.5.tar.gz
Algorithm Hash digest
SHA256 d374e161d8d1c603d88343549eeb63b250a99852fc4728166694bbab02cdf9d6
MD5 ccdca147a659c2f8ddd29a625e95243a
BLAKE2b-256 563cf0f8b909121b04eedef44f8497f73a17b860dcbf5c1c89c4e2c2d7829cb5

See more details on using hashes here.

File details

Details for the file mdacli-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: mdacli-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 35.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for mdacli-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 72bf55dbb275a76b7ff5f2394e2f474f040bcc9f341cdd5be8c95fc8365d5ce6
MD5 c05ea3940d0534896383f145c57a9d94
BLAKE2b-256 b10bee6df288d0bc971553874d90d5fba2d7ea93ebab29c9c4861251f18166f3

See more details on using hashes here.

Supported by

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