1. Welcome to the Holumbus project!
    1. About
    2. Status
    3. Download
    4. License
    5. Requirements
    6. Installation
    7. Documentation
    8. Developers
      1. Automated build information
    9. Holumbus in Action
    10. Related Projects

Welcome to the Holumbus project!

About

Holumbus is a Haskell library which provides the basic building blocks for creating powerful indexing and search applications. This includes a framework for distributed crawling and indexing as well as distributed query processing. Additionally, a full-fledged distributed Map-Reduce framework is included.

To explore the power of Holumbus, have a look at Hayoo!, a Haskell API search engine, or download (see below) Holumbus and check out some of the included examples.

The Holumbus framework ist split into four sub-packages, which build upon each other but may also be used independently:

Some extensive documentation can be found in the following cookbooks:

Status

Currently, Holumbus is under heavy development and should not be considered for creating applications in productive environments. You can follow the development on our blog and on this page. We plan to release a first stable version of Holumbus throughout the year 2009.

Download

If you want to try Holumbus, you can get a current development snapshot using Git: 

$ git clone git://github.com/fortytools/holumbus.git

You can also browse the repository (see link in navigation above) and of course submit patches via github ;)

Distribution packages are available from Hackage for the following Holumbus libraries:

License

The Holumbus library is distributed under the terms of the MIT license. Please have a look at the LICENSE file in the package and the copyright note at the top of every source file.

Requirements

Holumbus is developed and tested with GHC 6.8 and 6.10 but will probably work with GHC 6.6 through minor adjustments. In addition to the libraries coming with GHC, Holumbus needs Binary, BZip, HDBC, HDBC-sqlite3, HXT, Regex-Compat, UTF8-String and PureMD5. To run the websearch example, the janus application server is required. Running the test suite requires QuickCheck and HUnit.

Installation

For each sub-project, a Cabal file is provided, therefore Holumbus can be installed using the standard Cabal way: 

$ runhaskell Setup.hs configure
$ runhaskell Setup.hs build
$ runhaskell Setup.hs install # with root privileges

For those more familiar to make, a Makefile is provided which has some shortcuts for the commands above: 

$ make configure
$ make build
$ make install # with root priviliges

To run the Holumbus test suite, you can use the alltests target: 

$ make alltests

The standalone examples can be built using the allexamples target (also see the README file included with each example): 

$ make allexamples

To build the package with profiling capabilities, the prof target can be used: 

$ make prof
$ make install # with root privileges

Documentation

Have a look at the API documentation for the searchengine, the mapreduce framework, the storage system and the distribution library generated by Haddock. You will also find some examples in the examples directory of the distribution.

More in-depth information about the Holumbus framework is available in the master's thesis The Holumbus Framework: Creating fast, flexible and highly customizable search engines with Haskell by Timo B. Hübel (available as PDF) as well as in the master's thesis The Holumbus Framework: Creating scalable and highly customized crawlers and indexers by Sebastian M. Schlatt (available as PDF). The Holumbus MapReduce System, the distribution library and the storage system are developed in the master's thesis The Holumbus Framework: Distributed computing with MapReduce in Haskell (available as PDF) by Stefan Schmidt.

Developers

http://www.fh-wedel.de/fileadmin/templates/fhw_images/fh_logo.gif

Holumbus is developed and maintained by Sebastian M. Schlatt, Timo B. Hübel, Stefan Schmidt and Sebastian Reese in cooperation with Dr. Uwe Schmidt and FH Wedel University of Applied Sciences.

Automated build information

Upon every check-in, the Holumbus library will be built and the test suite is executed. The results can be seen in the build log and the test coverage report below:

Holumbus in Action

Hayoo Logo

Hayoo! Haskell API Search (see HayooStats)

Related Projects

http://holumbus.fh-wedel.de/cabal.png http://holumbus.fh-wedel.de/quickcheck.png

To get started, see TracGuide. For a complete list of local wiki pages, see TitleIndex.