Malakh - deep zoom viewer
Research and development project requested by the National Library of Poland made by Laboratorium EE.
How to run a viewer on your own image?
Generating DZI files
First, prepare the environment:
- Get Python 2.7.
- Install the
libjpegdevelopment package with a system package manager, e.g. on OS X:
brew install libjpeg, on Ubuntu:
sudo apt-get install libjpeg-dev.
- Install the
sudo pip install Pillowor
sudo easy_install Pillow.
Firing up the viewer
First, construct a new Malakh object:
var malakh = containerSelectorOrElement configOverrides;
where the first argument points to a container element (or its selector) where Malakh will create its components. The container will be emptied.
var malakh = '#malakh_container';
Then, open an image:
Malakh will automatically deduce the tiles directory path from the above. If this path is non-canonical, you can provide it as an additional argument:
How to build your own Malakh
First, clone a copy of the main Malakh git repo by running:
git clone https://github.com/Polona/malakh.git
malakh directory and install the Node dependencies:
cd malakh && npm install
The built version of Malakh will be put in the
dist/ subdirectory, along with the minified copy and an associated map file.
Customizing own Malakh version
If you want to build your own, modified version, the above process may last too long. In that case, install the
grunt-cli package, this time globally, to have the
grunt binary available:
npm install -g grunt-cli
Make sure you have
grunt installed by testing:
Then, to get a complete, minified, linted version of Malakh, type the following:
If you don't want to build minified files (e.g. during development), run:
Special builds can be created that optionally exclude or include any of the following modules:
Make sure all Node dependencies are installed and all Git submodules are checked out:
npm install && grunt
To create a custom build, use the following special
The same applies to other modules.
Exclude all optional modules:
Note: dependencies will be handled internally, by the build process.