mdacli

A command line client for MDAnalysis Analysis classes.

These details have not been verified by PyPI

Project links

Project description

MDAnalysis command line interface

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.18 (2022-04-12)

Fixed typo in libcli.py

v0.1.17 (2022-04-07)

Added dihedral module

v0.1.16 (2022-02-25)

Do not convert None types

v0.1.15 (2022-02-25)

Set positional arguments as required in cli

v0.1.14 (2022-02-17)

corrects bump2version changelog update

v0.1.13 (2022-02-16)

Added conda package install instructions (#88)

v0.1.12 (2022-01-19)

Support list of AtomGroups as parameters (#82)
Simplify add_argument logic in create_CLI (#82)
Allow list of reference classes in module detection (#82)
Support for generic classes as reference in module detection (#82)
Rename save_results` to save (#82)
More tests for docstring parsing and CLI creation (#82)

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

Project details

These details have not been verified by PyPI

Project links

Release history Release notifications | RSS feed

0.1.32

Jul 9, 2024

0.1.31

Jul 8, 2024

0.1.28

Sep 29, 2023

0.1.27

Aug 25, 2023

0.1.26

Jun 27, 2023

0.1.25

Feb 21, 2023

0.1.24

Jan 27, 2023

0.1.19

Apr 12, 2022

This version

0.1.18

Apr 12, 2022

0.1.17

Apr 7, 2022

0.1.16

Feb 25, 2022

0.1.15

Feb 25, 2022

0.1.14

Feb 17, 2022

0.1.13

Feb 16, 2022

0.1.12

Jan 19, 2022

0.1.11

Jan 19, 2022

0.1.10

Jan 18, 2022

0.1.9

Jan 16, 2022

0.1.8

Jan 16, 2022

0.1.7

Dec 18, 2021

0.1.6

Dec 1, 2021

0.1.5

Dec 1, 2021

0.1.4

Nov 24, 2021

0.1.3

Nov 24, 2021

0.1.2

Nov 18, 2021

0.1.1

Nov 18, 2021

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

Uploaded Apr 12, 2022 Source

Built Distribution

mdacli-0.1.18-py3-none-any.whl (36.3 kB view details)

Uploaded Apr 12, 2022 Python 3

File details

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

File metadata

Download URL: mdacli-0.1.18.tar.gz
Upload date: Apr 12, 2022
Size: 236.8 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for mdacli-0.1.18.tar.gz
Algorithm	Hash digest
SHA256	`0bc7dccd5e7c1cb597e10afdac6dfb176f329fe888b6bd5febdce4c5fdf4efd2`
MD5	`c7b9c62d3dcef6c5ecb3f4cdeb8cd3d4`
BLAKE2b-256	`44072d580b42d0aa0545bcd6b3e3778560307c54fcd3900f0c237f2f924cce26`

See more details on using hashes here.

File details

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

File metadata

Download URL: mdacli-0.1.18-py3-none-any.whl
Upload date: Apr 12, 2022
Size: 36.3 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for mdacli-0.1.18-py3-none-any.whl
Algorithm	Hash digest
SHA256	`5f63a562ef2eb65ca5e32182ef10eb7279f743fe1c5d73dd965bf607ad410fb8`
MD5	`083f73367da67f987fdbb88b9b130f4f`
BLAKE2b-256	`be3aef282490cbdd3c9ad957cfba48e6b413e3be2c9770cbc00f1a29fbc7facf`