py_framels

support

Description

py_framels is a python binding to use framels rust lib in python

For documentation about framels: doc guide

The library only support 3 functions at the time.

Install

pip install py-framels

Usage

Exemple

import py_framels

print(py_framels.py_basic_listing(["toto.0001.tif","toto.0002.tif"]))

Should return

['toto.****.tif@1-2']

Functions

py_basic_listing

The function provide a packing of the frame sequences using framels format.

import py_framels

print(py_framels.py_basic_listing(["toto.0001.tif","toto.0002.tif"], False))

Should return

['toto.****.tif@1-2']

py_parse_dir

The function list all the files and folders in specific directory and pack them

import py_framels

py_framels.py_parse_dir("./fls/samples/big", False)

Return ['RenderPass_Beauty_1_*****.exr@0-96', 'RenderPass_DiffuseKey_1_*****.exr@0-96', 'RenderPass_Diffuse_1_*****.exr@0-96', 'RenderPass_Id_1_*****.exr@0-96', 'RenderPass_IndDiffuse_1_*****.exr@0-96', 'RenderPass_Ncam_1_*****.exr@0-41,43-96', 'RenderPass_Ncam_1_00042.exr.bkp', 'RenderPass_Occlusion_1_*****.exr@0-73,75-96', 'RenderPass_Occlusion_1_***.exr@74', 'RenderPass_Pcam_1_*****.exr@0-96', 'RenderPass_Reflection_1_*****.exr@0-96', 'RenderPass_SpecularRim_1_*****.exr@0-96', 'RenderPass_Specular_1_*****.exr@0-96']

py_recursive_dir

import py_framels

py_framels.py_recursive_dir("./fls/samples", False)

Return ['RenderPass_Beauty_1_*****.exr@0-96', 'RenderPass_DiffuseKey_1_*****.exr@0-96', 'RenderPass_Diffuse_1_*****.exr@0-96', 'RenderPass_Id_1_*****.exr@0-96', 'RenderPass_IndDiffuse_1_*****.exr@0-96', 'RenderPass_Ncam_1_*****.exr@0-41,43-96', 'RenderPass_Ncam_1_00042.exr.bkp', 'RenderPass_Occlusion_1_*****.exr@0-73,75-96', 'RenderPass_Occlusion_1_***.exr@74', 'RenderPass_Pcam_1_*****.exr@0-96', 'RenderPass_Reflection_1_*****.exr@0-96', 'RenderPass_SpecularRim_1_*****.exr@0-96', 'RenderPass_Specular_1_*****.exr@0-96', 'aaa.***.tif@1-5', 'big', 'foo_bar.exr', 'mega', 'response_1689510067951.json', 'samples', 'small']

Benchmark

This is benchmarks of the python binding py-framels vs pyseq at diffirent level of inputs. Time is always in seconds. Running python 3.11

paths	1	2	5	10	50	100
py_framels	0.000119	4.8e-05	3.2e-05	4.2e-05	0.000126	0.000269
pyseq	3.3e-05	7.2e-05	0.000201	0.000301	0.001697	0.003202

paths	100	1000	20000	25000
py_framels	0.000247	0.001901	0.037153	0.044438
pyseq	0.002923	0.031959	0.627248	0.799049

Note: there is an acceleration at the level of 20000 paths, this is due to the fact framels is multi-threaded at a threshold of 100000 paths and the bench simulate 5 aovs ( 5 x 20 000 = 100 000 paths ).