Giter Club home page Giter Club logo

systematik-catalogue-builder's Introduction

Systematik Catalogue Builder

Build Status codecov Javadoc Maven Central

An Web Annotation data builder for use with the Trellis Linked Data Platform.

Dependencies

  • A TSV formatted data file exported from the Chopin catalogue software
  • a file system directory containing the images referenced in the data file

Image Metadata Builder Process:

This file rather than the binaries will be used for all subsequent annotation builder processes.

Requirements

Building

$ buildtools/src/install/install-jpms.sh

Run at CLI

  1. Unpack distribution (located in build/distributions)
  2. customize configuration file (see lib/scbconfig-test-remote.yml)
  3. copy lib/scb.creator.sh to distribution bin folder (this replaces the default gradle exec script)
  4. execute ./scb.creator.sh $args

Arguments

Name Default Long Name Description
-b resources "builder" The builder implementation
-f (none) "from" The start index (this corresponds to the beginning body sequence identifier) for a collection set
-t (none) "to" The end index (this corresponds to the ending body sequence identifier) for a collection set
-c (none) "config" The absolute path to the configuration file
-i (none) "imageSourceDir" The absolute path to the imageSource Directory (optional)
-d (none) "dimManifest" The absolute path to the dimension Manifest (optional)
-m (none) "metadata" The absolute path to the metadata File (optional)

Configuration File

baseUrl: "http://localhost:8000/"
Name Default Description
baseUrl (none) A defined baseUrl for the HTTP/2 proxy HTTP(s) interface for Trellis
imageServiceBaseUrl: "http://workspaces.ub.uni-leipzig.de:8182/iiif/2/"
Name Default Description
imageServiceBaseUrl: (none) The baseUrl of the IIIF image service
imageMetadataServiceConfig:
  dimensionManifestFilePath: "https://workspaces.ub.uni-leipzig.de:8445/collection/vp/meta/dimension-manifest-test-8efc742f-709e-47ea-a346-e7bdc3266b49"
  imageSourceDir: "/images"
Name Default Description
dimensionManifestFilePath: (none) A URI or filesystemm path to the image dimension manifest
imageSourceDir: (none) An absolute filesystemm path to the image source files

See lib/scbconfig-test-remote.yml for additional values.

API

See [WIP]

systematik-catalogue-builder's People

Contributors

christopher-johnson avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.