THIS REPO IS OBSOLETE AND WILL SOON BE REMOVED

Please use milk-package

milk version 0.1.01 (Feb 17, 2019)

IMPORTANT NOTE: milk uses git submodules. Use git clone --recursive (see Downloading and Installing section)

Multi-purpose Imaging Libraries toolKit (milk)

milk is the primary source of nutrition for infant mammals (Wikipedia)

milk is used to prepare delicious drinks with cacao (cacao-org dev team)

code your RTC the milky way

Overview

Set of image processing tools and functions accessible through a command line interface (CLI). Holds images in RAM, with image stream support (shared memory with low-latency IPC support).

Written in C, optimized for performance.

Executable launches a command line interface (CLI). Type "help" in the CLI to get started.

MILK is used by the following packages:

• Compute and Control for Adaptive Optics (cacao)
• Coronagraph Optimization For Exoplanets Exploration (coffee)
• future modules YOU can code

Downloading and installing

The MILK package follows the standard git clone steps and GNU build process :

git clone https://github.com/milk-org/milk
cd milk
git submodule init
git submodule update
autoreconf -i
./configure
make
make install

Note: On OS X you need to use gcc-mp-5 for openMP:

./configure "CC=/opt/local/bin/gcc-mp-5" CPPFLAGS="-I/usr/include/malloc/ -I/opt/local/include/readline" LDFLAGS="-L/opt/local/lib/"

(Replace "/opt/local/" is the location of your installed libraries. )

Reporting bugs, issues

Report bugs and issues on this page

Contributing to project

See coding standards

Documentation

Online documentation

Libraries

The following libraries are used:

• libtool
• automake
• readline, for reading the command line input
• ncurses-dev
• flex, for parsing the command line input
• bison, to interpret the command line input
• fftw, for performing Fourier Transforms
• gsl, for math functions and tools
• fitsio, for reading and writing FITS image files
• CUDA, CuBLAS, MAGMA for GPU acceleration (optional)

If you use NVIDIA GPUs, install cuda and magma libraries, and add "--enable-cuda and --enable-magma" options to the configure command.

Getting Started

All functions are accessible from the command line interface (CLI). Enter the CLI and type "help" for instructions.

    ./bin/milk

LICENCE

GNU General Public License v3.0