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

Uploaded Source

Built Distribution

mdacli-0.1.8-py3-none-any.whl (35.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mdacli-0.1.8.tar.gz
  • Upload date:
  • Size: 235.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 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.8.tar.gz
Algorithm Hash digest
SHA256 52f0037ab5fe19dd1fc7c122c3694962f56f3d56923cf5c6d8af7a9df84c5740
MD5 e63f5e7531377beca220b0c4725f9d35
BLAKE2b-256 4192316f19f0953e576be8d4864045a24b27e9b899f2dc351ab491b7b80f8f6f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mdacli-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 35.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 8861e7fc926a8e66027972a9f9b0dae7f006d3e1551a57f4319e79abfa6f60ad
MD5 56ff472dc311a32caf85e7f88e988723
BLAKE2b-256 beb6a3e58d6c81ce5643feed138f2abdf5576c96878f4774bcbf855cbe8183d2

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