Skip to main content

A textual user interface (TUI) for MDAnalysis

Project description

MDAnalysis TUI

A textual user interface (TUI) for MDAnalysis trajectory transformations

https://github.com/p-j-smith/mda-tui/assets/29753790/b73c1a7e-ca97-41cd-b7a2-09899ecf1cb3

Latest release Last release tag GitHub commits since latest release (by date) for a branch Documentation Status
Status Tests codecov Linting
Community License: GPL v2 Powered by MDAnalysis

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.

Project details


Download files

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

Source Distribution

mda_tui-0.4.0.tar.gz (3.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mda_tui-0.4.0-py3-none-any.whl (28.4 kB view details)

Uploaded Python 3

File details

Details for the file mda_tui-0.4.0.tar.gz.

File metadata

  • Download URL: mda_tui-0.4.0.tar.gz
  • Upload date:
  • Size: 3.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mda_tui-0.4.0.tar.gz
Algorithm Hash digest
SHA256 24b7fffce1f246d2dd39c21e82f0e86ae1706841a1a89884cda806f9a9c11494
MD5 392fc156e0af51bdf9df75f32874da37
BLAKE2b-256 967271f1c70928a9fbb9201125ee1e39340447ec2a67fc21b50519f6e451299b

See more details on using hashes here.

File details

Details for the file mda_tui-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: mda_tui-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 28.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mda_tui-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c63c555a21430ebef64f32705bacaf92e36d5d334a7c673a3dcfc28daf6d1f22
MD5 276555276c62e2feaf52ec1bb26347c7
BLAKE2b-256 96d07d53e52da30846fc7b806088cb69a609dbd13b4ebd27147292ff28620f6f

See more details on using hashes here.

Supported by

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