Metadata-Version: 2.4
Name: molprisma
Version: 1.0.1
Summary: Tool for fast inspection of PDB molecular files inside the terminal
Home-page: https://github.com/diegobarmor/molprisma
Author: DiegoBarMor
Author-email: diegobarmor42@gmail.com
License: MIT
Keywords: pdb rcsb molecular terminal tui protein nucleic rna dna ligand
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: prismatui==0.3.2
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# MolPrisma
This is a tool for fast inspection of PDB molecular files inside the terminal. It is very lightweight, its only dependency being the [Prisma TUI](https://github.com/DiegoBarMor/prismatui) framework (which itself has no dependencies for Linux).

## Quickstart
```bash
pip install molprisma
molprisma your_file.pdb
```

## Features
![MolPrisma Logo](logo.png)
- Use the `UP`,`DOWN`,`PREVPAGE`,`NEXTPAGE`, `-` (top) and `+` (end) keys to quickly nagivate through the PDB rows.
- Use the `LEFT` and `RIGHT` keys to highlight a concrete PDB section (i.e. column) and see their indices/name (according to [the standard](https://www.cgl.ucsf.edu/chimera/docs/UsersGuide/tutorials/pdbintro.html)).
    - Visual separation of the PDB sections via colors also helps to easily spot offset issues.
- Show/hide whole groups of rows via a simple key press:
    - `1`: Toggle between showing all or showing nothing.
    - `2`: Toggle the *atoms* (lines starting with `ATOM`).
    - `3`: Toggle the *heteroatoms* (lines starting with `HETATM`).
    - `4`: Toggle the *metadata* (everything else not considered by `2` or `3`). It is hidden by default.
- Filter out rows that don't match a specific combination of values.
    - `a`: Alternate *atom_name* value to filter.
    - `r`: Alternate *residue_name* value to filter.
    - `e`: Alternate *element_id* value to filter.
    - `c`: Alternate *segment_id* (a.k.a chain) value to filter.
    - `i`: Alternate *residue_insertion_code* value to filter.
    - `l`: Alternate *altloc* (i.e. alternate location indicator) value to filter.
- Reset the shown/hidden groups and the filters at any moment by pressing `k`.
