Skip to main content

Light-sheet Dataset EXploration and Processing

Project description

fishcolorproj

dexp | light-sheet Dataset EXploration and Processing

dexp is a napari, CuPy, Zarr, and DASK based library for managing, processing and visualizing light-sheet microscopy datasets. It consists in light-sheet specialised image processing functions (equalisation, denoising, dehazing, registration, fusion, stabilization, deskewing, deconvolution), visualization functions (napari-based viewing, 2D/3D rendering, video compositing and resizing, mp4 generation), as well as dataset management functions (copy, crop, concatenation, tiff conversion). Almost all functions are GPU accelerated via CuPy but also have a numpy-based fallback option for testing on small datasets. In addition to a functional API, DEXP offers a command line interface that makes it very easy for non-coders to pipeline large processing jobs all the way from a large multi-terabyte raw dataset to fully processed and rendered video in MP4 format.

How to install dexp

Prerequisites:

dexp works on OSX and Windows, but it is recomended to use the latest version of Ubuntu. We recommend a machine with a top-of-the-line NVIDIA graphics card (min 12G to be confortable).

First, make sure to have a working python installation Second, make sure to have a compatible and functional CUDA installation

Once these prerequisites are satified, you can install dexp.

Installation:

dexp can simply be installed with:

To installs dexp with GPU support (CUDA 11.2), colored console output, and napari support do:

pip install dexp[color, cuda112, napari]

Other available CUDA versions (from CuPy) are: cuda111, cuda110, cuda102, cuda101, cuda100. We recommend using the most recent CUDA version that your system supports, and avoiding versions below 10.0

If instead you do not wish to add CUDA support, you can instead do:

pip install dexp

For OSX users: Before installating dexp, you will first need to install cairo:

brew install cairo

Quick one-line environment setup and installation:

The following line will delete any existing dexp environment, recreate it, and install dexp with support for CUDA 11.2:

conda deactivate; conda env remove --name dexp; conda create -y --name dexp python=3.8; conda activate dexp; pip install dexp[color,cuda112, napari]

Leveraging extra CUDA libraries for faster processing:

If you want you dexp CUDA-based processing to be even faster, you can install additional libraries such as CUDNN and CUTENSOR with the following command:

install cudalibs 11.2

Change the CUDA version accordingly...

Versions

The list of released versions can be found here. The version format is: YYYY.MM.DD.M where YYYY is the year, MM the month, dd the day, and M is the number of elapsed minutes of the day. Git tags are automatically set to link pipy versions to github tagged versions so that the corresponding code can be inspected on github, probably the most important feature. This is a very simple and semantically clear versionning scheme that accomodates for a rapid rate of updates.

How to use dexp ?

First you need a dataset aqquired on a light-sheet microscope, see here for supported microscopes and formats.

Second, you can use any of the commands here to process your data. The list of commands can be found by :

dexp --help

Example usage

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dexp-2021.4.11.538.tar.gz (180.8 kB view details)

Uploaded Source

Built Distribution

dexp-2021.4.11.538-py2.py3-none-any.whl (316.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file dexp-2021.4.11.538.tar.gz.

File metadata

  • Download URL: dexp-2021.4.11.538.tar.gz
  • Upload date:
  • Size: 180.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.6.1 requests/2.25.0 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.5

File hashes

Hashes for dexp-2021.4.11.538.tar.gz
Algorithm Hash digest
SHA256 72db9b8637ed09a9e162bff4ba08a4931ff100e12d0a81d24346411e0ae33336
MD5 9ceb0eef761306601b240a88642f316a
BLAKE2b-256 c71eb3fbbfb1730f5a75435352211698de9b06d4f0fe75ff5312b4afa3fff936

See more details on using hashes here.

File details

Details for the file dexp-2021.4.11.538-py2.py3-none-any.whl.

File metadata

  • Download URL: dexp-2021.4.11.538-py2.py3-none-any.whl
  • Upload date:
  • Size: 316.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.6.1 requests/2.25.0 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.5

File hashes

Hashes for dexp-2021.4.11.538-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4f3468628fcc33f492ddd53b48ebea44490cfa749059e61a037b0e3bd79482ed
MD5 6e7a9c406679841517483fbb82f5113c
BLAKE2b-256 80fb602adf3fcc976f901ffea3a74399633a6f56aa2c351bf528237cd21793a9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page