histonets

|

Histonets is an application to convert images of scanned maps into digital networks.

Installation

Install the Ruby dependencies

$ bundle install

Install node, npm, and yarn

# Installing Node and npm see: https://nodejs.org/en/download/ or
$ brew install node

# Installing yarn
$ npm install -g yarn

Histonets uses riiif for IIIF image api support. This requires imagemagick. To install on OSX:

# With options for pdf, tiff, and jp2 respectively (not necessarily needed)
$ brew install imagemagick --with-ghostscript --with-tiff --with-jp2

Install the Python library histonets. Developers may want to install this into a virtualenv. For now it's only available from its repository. It also needs a Python version 3.4 or higher.

$ pip3 install https://github.com/sul-cidr/histonets-cv/archive/master.zip

The application also uses redis for background job queueing. Make sure to have redis installed as background jobs get scheduled automatically.

$ brew install redis

Setup

Histonets uses two commands to seed the application with collections of images. Make sure that all images are contained with directories within the data/ directory. Each subdirectory within data should be flat, i.e., should contain no further subdirectories of images.

bundle exec rails db:seed will iterate over data, creating a new collection in the application for each subdirectory. It will also iterate over the images in each subdirectory, creating an image model for each and associating it with the proper collection.

bundle exec rake histogram will iterate over all collections in the application, calculating the composite histogram and palette of each. Before running this command, make sure all of the images from the subdirectories in data have been copied over to spec/fixtures/images where the image server points. Due to the restrictions of the image server, all images should exist at the same level within spec/fixtures/images.

Running the application

Run the application

$ rails s

Run the redis server

$ redis-server

Run the sidekiq job processor

$ bundle exec sidekiq

Running the tests

Run the tests

$ bundle exec rake

Run the JavaScript linting

$ node_modules/.bin/eslint ./

Updating the deployed CLI

$ bundle exec cap dev python:update_cli