pyterse 0.1.0

A Python interface for the TERSE library using pybind11.

PyTERSE

Python package of TERSE/PROLIX diffraction and cryo-EM data compression algorithm

The pyTERSE python package uses the c++ TERSE/PROLIX(TRPX) compression algorithm scheme (https://github.com/senikm/trpx) and adds python binders to it's main class. After the compilation the build directory contains the python compression library, which can be imported to a python environment.

How to Install the Package

Create a virtual environment with pybind and cmake

For example:

mamba create -n pyterse python cmake pip pybind11 numpy pillow

OR

conda create -n pyterse python cmake pip pybind11 numpy pillow

And then install the package

pip install pyterse_master.zip

---

---

How to compile the code

First, navigate to the project directory. Then, execute the following commands:

mkdir build
cd build
cmake ..
make

Alternatively, if you want to distribute the package, run the following command:

python3 setup.py sdist --inplace

Or run the following command to install the pip package:

pip3 install --use-feature=in-tree-build . 

• Please note that in case of specific builds special care should be taken for these lines in root CmakeLists.txt: the paths of python and pybinder may be hardcoded based on specific needs before the compilation

# Find Python and PyBind11
find_package(Python REQUIRED COMPONENTS Interpreter Development)
find_package(pybind11 REQUIRED) 

---

Testing the functionality of the library

Basic commands

• Create terse object:

terse = Terse()

• Add data to Terse object:

terse.push_back(data)

• Save compressed data to a file:

terse.save('filename.trpx')

• Load compressed data from a file:

loaded_terse = Terse.load('filename.trpx')

• Decompress a specific frame:

decompressed_frame = loaded_terse.prolix(frame_index)

---

Running the test file.

python3 test.py