FlatCAT documentation

Version:

0.8.1

Date:

May 10, 2026

FlatCAT is personal collection of scripts and utilities that extend functionality of PyMOL molecular visualization tool. The inspiration behind the library is to learn how to work with PyMOL and create a collection of useful functions for easy and convenient use. It is heavily inspired and borrows (i.e. shamelessly steals) ideas from Pymol ScrIpt COllection (PSICO).

Source code is available in the public GitHub repository: https://github.com/JureCerar/flat

Installation

The package can be installed by cloning the repository and running:

pip install .

Usage

Once installed, you can import and initialize package in PyMOL by typing:

import flat.fullinit

Note

To import FlatCAT package in PyMOL at startup, add this to your ~/.pymolrc.py file or add it in PyMOL under File → Edit pymolrc.

You can then use built-in help in PyMOL to get command documentation:

PyMOL> help flat

Getting help

Please report bugs and feature requests for FlatCAT through the Issue Tracker.

Contributing

All contributions are welcome. To contribute code, submit a pull request against the master branch in the repository.

License

This program is licensed under the GNU General Public License v3.0.