Skip to content

scenerygraphics/trx-jvm

Repository files navigation

trx-jvm

build

A library implementing TRX (say, tee-ar-ex) file reading for JVM-based languages. trx-jvm was written with performance in mind, and uses imglib2 CellImgs for large array storage and access. It is able to parse and load a 4 GiB TRX file with 500000 streamlines in about 18 seconds1.

Building

Run ./gradlew build in a terminal in this directory.

Testing with your own TRX files

Run ./gradlew test --info -Dtrx.filename=path/to/file.trx from this directory.

Debug output

trx-jvm uses slf4j for logging. You can set the log level via the slf4j backend you use. The tests use slf4j-simple, you can set the log level there via the system property org.slf4j.simpleLogger.defaultLogLevel.

Usage from a Gradle project

There are no releases yet, but you can use jitpack.io to depend on the latest trx-jvm repository version in your own project:

repositories {
    // ...
    maven("https://jitpack.io")
}

dependencies {
    // ...
    implementation("com.github.scenerygraphics:trx-jvm:master-SNAPSHOT")
}

Footnotes

  1. Single-threaded, tested on a 2021 M1 Max MacBook Pro.

About

TRX file support for the JVM

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages