Skip to content
/ pyTAB Public

Python Transcoding Acceleration Benchmark Client made for Jellyfin Hardware Survey

License

Notifications You must be signed in to change notification settings

BotBlake/pyTAB

Repository files navigation

pyTAB

Python Transcoding Acceleration Benchmark

Note. This is an Alpha Version of the Client. It has not been properly tested, nor implemented for all Platforms yet! Use at your own risk.

Testing guide for pyTAB

pyTAB is in heavy development a.t.m. so expect it to be laggy and crash. Since it is a Hardware Benchmark, it will try to use as many System Ressources as possible!

Software Requirements

Also pyTAB is build as a python module via poetry. Therefore you need to have at least python 3.11.2 and poetry installed on your system. poetry is installed via pipx using: pipx install poetry If you do not have pipx installed, follow the official install guide

Its also required to have access to a running instance of Venson's Jellyfin Hardware Visualizer. More information about that is available in the GitHub repo.

Installing pyTAB

  1. Clone the GitHub Repository git clone https://github.com/BotBlake/pyTAB
  2. Go into the pytab Folder cd pytab
  3. Switch to the development branch git switch develop
  4. Open the venv shell poetry shell
  5. Install Dependencies poetry install
    (To exit the Shell: exit)

Since the state of the software often Changes, you might have to do some "additional steps" to ensure its running correctly. They are explained down below.

Running pyTAB

  1. open the poetry shell poetry shell
  2. run the script pytab --server "https://Your/Test/Server/" If you want / need specific info about all the CLI Arguments, do pytab -h

(If you do not care about the actual test results, you can use the developer mode through --debug and specify a local file Path instead of a Server URL.)

Additional Steps

During development pyTAB may require you to set up specific things manually these will change over Time

  • Make sure you are on the latest version git pull
  • Take a Look into the "Current Issues" section

Hardware Control

To reduce Test Runtime you can disable certain hardware reducing the number of tests you run.

  • CPU based tests can be disabled using the --nocpu flag
  • GPU based tests can be disabled using the --gpu 0 option or by selecting 0 in the interactive GPU selector
  • If the CPU and GPU are disabled the program will error out saying "ERROR: All Hardware Disabled"

Current Issues

OS Support

Since a lot of Hardware recognition is not yet implemented for Linux based Systems, these are currently not supported. Try running the Script on Windows instead.

  • Use Windows 🗿

About

Python Transcoding Acceleration Benchmark Client made for Jellyfin Hardware Survey

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages