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 Status Github Actions Test 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.11 (2022-01-19)

  • Improved help for run parameters (#83)

v0.1.10 (2022-01-18)

  • Removed conda dependency from CI and tox (#86)

v0.1.9 (2022-01-16)

  • Fix test banner in README.rst (#85)

v0.1.8 (2022-01-16)

  • Use Github actions matrix for tests (#68)

  • Fix Conda permissions on MacOS (#68)

  • Fix Tests failing on Windows (#68)

v0.1.7 (2021-12-18)

  • Improves regex to convert from time to frame (#81)

v0.1.6 (2021-12-01)

  • Fixed URL in docs (#80)

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.11.tar.gz (235.6 kB view details)

Uploaded Source

Built Distribution

mdacli-0.1.11-py3-none-any.whl (35.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mdacli-0.1.11.tar.gz
  • Upload date:
  • Size: 235.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1

File hashes

Hashes for mdacli-0.1.11.tar.gz
Algorithm Hash digest
SHA256 c9949bbeef7b2e99888e4389ecb90c056836bc360e2ea0eb99f6095b7071cb37
MD5 eb906d7dcc25b565381facdbc106537e
BLAKE2b-256 1e4a55e600efe0e74a5effc673f77a26b0488aaaf74563e9476e8456c014c635

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mdacli-0.1.11-py3-none-any.whl
  • Upload date:
  • Size: 35.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1

File hashes

Hashes for mdacli-0.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 3eacd1be31fbdf7f3f08c8838263962715f7ad70c35abd95b67a1ca808b3874d
MD5 f6d245fe1f4d2d96c05a735bcaea3ec1
BLAKE2b-256 de4b6de94a78c395b01f495e922f987d120481ddebaa0c8e7d0e1447d7b0118a

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