Skip to content

kmisiunas/particle-linking-klab

Repository files navigation

Particle linker in scala (KLab)

Project aimed at analysing diffusion experiment data using Scala/Java.

Warning: academic, unmaintained code. Use at your own risk!

Warning: superseeded by a new version. Please ask

Roadmap

  • Develop import code from external video trackers
  • Create sophisticated track reconstruction algorithm (urgent!)
  • Full integration with breeze and universality of analysis results
  • JSON as iterator
  • Automatic buffering Assembly for very large data sets
  • Redesign Assembly
  • universal id system
  • JSON save LQPos points
  • Integration with Mathematica for general analysis - use Mathematica's plotting

Self Comments

On transition to scala 2.11: It seems REPL got major changes - a lot of the code was reduced. It is not clear how to cleanly integrate it with KLab. Biggest problem is that auto-complete does not pick up objects from context. Only if the variable type is known.

Starting

Start app by double clicking the 'KLab.jar' file, it will give an option to copy the command that should be pasted into Console, Terminal or PowerShell. Flag -t indicates that terminal version should be started. If libraries are stored outside the main JAR file one should run it via: 'java -cp "KLab.jar:KLab-assembly-0.1.4-deps.jar" klab.klab -t'

Basic Usage

The simplest way to get started is with 'Run()' command. It runs an automated analysis script. If 'Run()' is typed it will display all known scrips - this includes packaged ones with the software and also ones in '/scripts/' folder. An example is scrip would be 'Run("example_script")'.

Useful SBT compiler commands

  • 'compile' compiles the code
  • 'assembly' generate KLab.jar runnable file
  • 'pack' a quick way of packing klab, where libraries are left unchanged
  • 'gen-idea' generates library bindings with intellij IDEA
  • 'doc' generate scaladocs
  • 'clean' helps to remove sbt compilation artifacts

Requirements

  • JVM 1.6 or 1.7
  • Recommended to have BLAS or LAPACK installed
  • Scala 2.10.3 (for compilation)
  • SBT 0.13 (for compilation)

Authors

Karolis Misiunas k.misiunas@gmail.com

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published