MDAnalysis TUI

A textual user interface (TUI) for MDAnalysis trajectory transformations

mda-tui.mp4

Latest release
Status
Community

Warning

MDanalysis TUI is alpha software and may change without warning.

Installation

When installing MDAnalysis TUI, we highly recommend using virtual environments. We recommend that you use uv or pixi as your package manager.

Assuming you're using uv, create and activate a new virtual environment with:

uv venv --python=3.14
source .venv/bin/activate

Then install MDAnalysis TUI with:

uv pip install mda_tui

Installation from source

To build MDAnalysis TUI from source, follow the above steps for creating a virtual environment, clone this repository:

git clone https://github.com/p-j-smith/mda-tui.git

Then inside your virtual environment type:

uv sync

By default, this will install MDAnalysis TUI in editable mode along with the dependencies required for development (testing, linting, and building the documentation).

Code of conduct

MDAnalysis TUI is bound by a Code of Conduct.

Copyright

The MDAnalysis TUI source code is hosted at https://github.com/p-j-smith/mda-tui and is available under the GNU General Public License, version 2 (see the file LICENSE).

Copyright (c) 2023, Paul Smith

Acknowledgements

Project based on the MDAnalysis Cookiecutter version 0.1. Please cite MDAnalysis when using MDAnalysis TUI in published work.