# Welcome to *ClearVolume* #

[![Join the chat at https://gitter.im/ClearVolume/ClearVolume](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ClearVolume/ClearVolume?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Build Status](https://github.com/ClearVolume/clearvolume/actions/workflows/build.yml/badge.svg)](https://github.com/ClearVolume/clearvolume/actions/workflows/build.yml)

![ClearVolume Logo](artwork/ClearVolumeLogo.png "Logo")

ClearVolume is a real-time live 3D visualization library designed for high-end volumetric microscopes such as SPIM and DLSM microscopes. With ClearVolume you can see live on your screen the stacks acquired by your microscope instead of waiting for offline post-processing to give you an intuitive and comprehensive view on your data. The biologists can immediately decide whether a sample is worth imaging. 

ClearVolume can easily be integrated into existing Java, C/C++, Python, or LabVIEW based microscope software. Moreover, it has a dedicated interface to MicroManager/OpenSpim/OpenSpin control software. In addition, it offers the possibility of remote viewing of volume data

## Building from source

In order to only build the Java parts of the project, simply run `./gradlew build`. Should you also want to build the native/C++ parts (e.g., for LabVIEW integration), run `build.bat` or `build.sh`.

## Wiki and Website

For up to date information about the project,
please go to the [website](http://clearvolume.github.io) or have a look at the [wiki](http://github.com/clearvolume/clearvolume/wiki/Home)


