ShuttleTracker: Difference between revisions
From Laboratory of Modeling in Biology and Medicine
mNo edit summary |
mNo edit summary |
||
| Line 8: | Line 8: | ||
The latest S<span style="font-variant:small-caps">huttle</span>T<span style="font-variant:small-caps">racker</span> version is '''1.3.0''' (September 2019). | The latest S<span style="font-variant:small-caps">huttle</span>T<span style="font-variant:small-caps">racker</span> version is '''1.3.0''' (September 2019). | ||
</div></div> | </div></div> | ||
<br/><br/> | |||
===Documentation=== | |||
* User's manual: [{{SERVER}}/software/shuttletracker/release/shuttletracker-1.3.0-manual.pdf shuttletracker-1.3.0-manual.pdf] | |||
* Step-by-step tutorial: [{{SERVER}}/software/shuttletracker/release/shuttletracker-1.3.0-tutorial.pdf shuttletracker-1.3.0-tutorial.pdf]<!--<span style="background:yellow"> ''' TODO ''' </span>--><br/>and associated input images: [{{SERVER}}/software/shuttletracker/tutorial/March26_WellB_Pos09.zip March26_WellB_Pos09.zip] (~1.3 GB) | |||
<br/><br/> | <br/><br/> | ||
| Line 37: | Line 43: | ||
More detailed instructions are provided in file COMPILING.md in the source code package. You may also have a look at how the build process is automated in a Singularity container recipe distributed in source code distribution subdirectory distrib/singularity.<br/></accordion> | More detailed instructions are provided in file COMPILING.md in the source code package. You may also have a look at how the build process is automated in a Singularity container recipe distributed in source code distribution subdirectory distrib/singularity.<br/></accordion> | ||
<br/> | <br/> | ||
===Contact=== | ===Contact=== | ||
Revision as of 16:20, 4 October 2019
An interactive tool for analyzing nucleocytoplasmic shuttling
of fluorescent reporters
of fluorescent reporters
ShuttleTracker can detect stained cell nuclei, generate corresponding annular perinuclear extensions, quantify geometric and photometric properties of detected objects, and perform frame-to-frame nuclei tracking. Parameters of the image processing algorithms can be changed manually and the effects of these changes can be seen nearly immediately overlaid on currently displayed microscopic images. A key capability of ShuttleTracker is that nuclear contours and tracks can be generated automatically and then corrected manually. The tool is scriptable.
The latest ShuttleTracker version is 1.3.0 (September 2019).
Documentation
- User's manual: shuttletracker-1.3.0-manual.pdf
- Step-by-step tutorial: shuttletracker-1.3.0-tutorial.pdf
and associated input images: March26_WellB_Pos09.zip (~1.3 GB)
Stand-alone binary executables for Windows and Mac
- Windows 64-bit installer: shuttletracker-1.3.0-x86_win64-setup.exe
COMPATIBILITY: This software was built with MSVC14 on Windows 10, and tested on Windows 10 and Windows 8. An installer of Microsoft Visual C++ 2017 Redistributable (required runtime libraries) is contained in the ShuttleTracker installer.
SECURITY: The downloadable installer is not signed with a certificate (so in Windows parlance it comes from an "unknown publisher"); however, its integrity can be checked manually in command line using a Windows pre-installed utility:
SECURITY: The downloadable installer is not signed with a certificate (so in Windows parlance it comes from an "unknown publisher"); however, its integrity can be checked manually in command line using a Windows pre-installed utility:
certUtil -hashfile path_to_installer MD5
MD5 sum of untainted shuttletracker-1.3.0-x86_win64-setup.exe is 18d220e5d499239a50b75da2df68a05d.- macOS application bundle (zipped "app"): shuttletracker-1.3.0-x86_64-darwin17.zip
COMPATIBILITY: This software was built with XCode 8 and tested under macOS 10.13 (High Sierra). It is likely incompatible with previous Mac operating system releases.
SECURITY: MD5 sum of the downloadable ZIP archive can be checked in Terminal:
SECURITY: MD5 sum of the downloadable ZIP archive can be checked in Terminal:
md5 path_to_zip
MD5 sum of untainted shuttletracker-1.3.0-x86_64-darwin17.zip is 7cffa9c8ec21e7972471003ac165d072.
Containers for Linux
- A docker-based recipe for a Singularity container: shuttletracker-1.3.0-singularity.recipe
BUILDING a container (in terminal):
LAUNCHING the simulator within a container (in terminal):
sudo singularity build --sandbox st shuttletracker-1.3.0-singularity.recipe
LAUNCHING the simulator within a container (in terminal):
singularity exec --writable st /opt/local/bin/ShuttleTracker
Source code
ShuttleTracker source code is distributed under GNU GPL v3.0.
- C++ source code: shuttletracker-1.3.0-source.tar.gz
Compilation on Linux, macOS, and Windows is managed by CMake, which is expected to be used in the standard way:
More detailed instructions are provided in file COMPILING.md in the source code package. You may also have a look at how the build process is automated in a Singularity container recipe distributed in source code distribution subdirectory distrib/singularity.
tar xfz shuttletracker-1.3.0-source.tar.gz cd shuttletracker-1.3.0-source mkdir build && cd build cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/opt/local/ make -j4 && make install
Contact
The lead software developer is Marek Kochańczyk. For both user's and developer's queries please use the following e-mail address: shuttletracker.software@gmail.com
