No description, website, or topics provided.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
the-mathmos-parent
the-mathmos-server
.gitignore
.pre-commit-config.yaml
.travis.yml
API.md
CONTRIBUTING.md
LICENSE
README.md
settings.xml

README.md

The Mathmos

The Mathmos is a Web Search Service compliant with the IIIF Content Search API. We can index Annotations provided by the Elucidate Server using Pygar. Elucidate can put messages into an AWS SQS Queue whenever an Annotation is created, updated or deleted. We can index Image Text provided by the Starsky Server using Barbarella. Starsky can put messages into an AWS SQS Queue which contain the text associated with an image.

Build Status

Branch Status
master Build Status
develop Build Status

Getting Started

Prerequisites

Java 8+
Apache Tomcat 8+
Elasticsearch 5.4.0
Springdata for Elasticsearch 3.0.0.M4

The Mathmos Server and its dependencies are written in pure Java, and is designed to work with Elasticsearch.

Building

The Mathmos Server has a dependency that must be built first:

  • the-mathmos-parent
    • Parent Maven project that defines dependency library version numbers and common dependencies Each dependency and the Mathmos Server itself can be built using Maven:
mvn clean package install -U

Configuration

The location of the coordinate service and the cluster nodes need to be provided to the JVM as a parameter:

-Dtext.server.coordinate.url="http://wherever.the.coordinate.server.exists" -Dcluster.nodes="localhost:9300"

API

Please read API.md for details on how Mathmmos works.

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the MIT License - see the LICENSE.md file for details