Metadata-Version: 2.4
Name: timol
Version: 0.1.3
Summary: 3D Molecular viewer in the terminal
Author-email: GregoryFonseca <gregorycordeirofonseca@gmail.com>
License-Expression: MIT
License-File: LICENSE
Requires-Python: >=3.12
Requires-Dist: ase>=3.24.0
Requires-Dist: importlib-resources>=6.5.2
Requires-Dist: numpy>=2.2.4
Requires-Dist: textual>=2.1.2
Description-Content-Type: text/markdown

## About Timol 

Timol is a molecular visualiser inside of the terminal. It relies on [ASE](https://wiki.fysik.dtu.dk/ase/) to read a molecular file (e.g. xyz) and displays it within a [Textual](https://github.com/textualize/textual/) app. 
![Timol_example](https://github.com/user-attachments/assets/7a90b016-a5ff-4bf6-8fdd-d2106261f61c)

## Installation

tbd

## Usage

In order to visualise a file of interest, simply call `timol <file_path>`. An optional argument (`-i`) can be provided to index the file in case only specific frames are of interest (note that this can also be done from within the app using the `g` hotkey). 

In order to test the app without a molecular file at hand, use `timol test`.

## Functionalities

Timol provides a set of tools to conveniently manipulate the camera and more:
- **Help**: Press `h` to view available hotkeys from within the app
- **Rotate**: Drag the mouse or press `a/d` and `w/s`
- **Pan**: Hold shift and drag the mouse or press `shift+a/d`
- **Zoom**: Scroll or press `shift+w/s`
- **Change index/frame**: Press `q/e` (or `shift+q/e`) to go to the previous/next (or first/last) frame, press `g` to manually input the index

## MacOS Disclaimer

The default MacOS terminal app does not play nice with Textual apps and might make the rendering choppy. For more information and a solution to _some_ of the issues, see the [Textual FAQ](https://textual.textualize.io/FAQ/#why-doesnt-textual-look-good-on-macos)
