sfb-annotator
Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 5 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (8.3%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: lisestork
- License: apache-2.0
- Language: JavaScript
- Default Branch: master
- Size: 33.4 MB
Statistics
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 4
- Releases: 0
Metadata Files
README.md
Semantic Field Book Annotator
The Semantic Field Book Annotator is a web application developed for domain experts to harvest structured annotations from field books, drawings and specimen labels of natural history collections. Users can draw bounding boxes over (zoomable) image scans of historical field notes, to which annotations can be attached. All metadata regarding an annotation event, annotation provenance, transcription and semantic interpretation of the text are stored in a knowledge base, which is accessible via a SPARQL endpoint and Web API.
Prerequisites
Software used
- Eclipse RDF4J Server and Workbench
- grlc Web API
- Cantaloupe IIIF image server
- Mirador IIIF image viewer
- Annotorius
- OpenSeadragon
Vocabularies, ontologies & specs used
- Web Annotation Vocabulary
- International Image Interoperability Framework (IIIF)
- Darwin Core (DwC)
- Darwin Semantic Web (Darwin-SW)
- Dublin Core (DC)
Install & deploy
1. Clone this repository.
bash
git clone https://github.com/LINNAE-project/SFB-Annotator.git
2. Install Docker Compose.
bash
pip install docker-compose
3. Start Docker service(s).
| Service | Port | Docker Image | Description |
| ------- | ---- | -------------| ----------- |
| sea | 8080 | linnae/sfb-annotator | Semantic Field Book Annotator |
| melon | 8182 | linnae/cantaloupe | Cantaloupe image server |
| mirador | 8000 | linnae/mirador | Mirador image viewer |
| grlc | 8088 | clariah/grlc | Web API (optional)|
```bash cd SFB-Annotator
list available services
docker-compose config --services
start all services or one-by-one
docker-compose up -d # or append [SERVICE] ```
4. Configure service(s).
```bash
populate an empty RDF store (repository)
docker-compose exec sea ./init.sh
configure sea to use a remote image archive (optional)
default: data-local.json
BASEDIR=/usr/local/tomcat/webapps/semanticAnnotator/data/ IMGSRC=remote # default: local docker exec -it sea bash -c "cp $BASEDIR/data-$IMGSRC.json $BASE_DIR/data.json"
configure grlc to use local path (optional)
git clone https://github.com/LINNAE-project/queries docker cp ./queries grlc:/home/grlc/ ```
5. Build Docker image and deploy container locally (development)
```bash docker build -t linnae/sfb-annotator:local . docker run --name sea -d -p 8080:8080 linnae/sfb-annotator:local docker exec sea ./init.sh
generate RDF triples for example inputs (annotation events)
for json in $(ls data/json/$IMG_SRC/*.json | sort) do prefix="$(basename "$json" .json)" suffix=ttl # or jsonld rdf="$prefix.$suffix" ./run.sh "$json" "$rdf" done ```
Web apps & API endpoints
- http://localhost:8080/semanticAnnotator/
- requires user/password:
tomcat/tomcat - Register->Save->Collections
- requires user/password:
- http://localhost:8080/rdf4j-workbench/
- includes an empty repository:
mem-rdf
- includes an empty repository:
- http://localhost:8080/rdf4j-server/
- http://localhost:8088/ followed by
- remote path
/api-git/LINNAE-project/queries/or - requires
GRLC_GITHUB_ACCESS_TOKENto be set indocker-compose.yml - local path
/api-local/
- remote path
- http://localhost:8182/iiif/2
- http://localhost:8000 includes an example
manifest.json- Add Item->Sample Field Book->Change view type to Book View
Owner
- Login: lisestork
- Kind: user
- Repositories: 1
- Profile: https://github.com/lisestork
Citation (CITATION.cff)
# YAML 1.2
# Metadata for citation of this software according to the CFF format
# (https://citation-file-format.github.io/)
---
authors:
-
affiliation: Leiden University
family-names: Stork
given-names: Lise
orcid: http://orcid.org/0000-0002-2146-4803
-
affiliation: "Netherlands eScience Center"
family-names: Kuzniar
given-names: Arnold
orcid: "https://orcid.org/0000-0003-1711-7961"
cff-version: "1.0.3"
title: "Semantic Field Book Annotator"
doi: 10.5281/zenodo.4602264
keywords:
- "semantic annotation"
- "natural history"
- "biodiversity"
- "field notes"
- "Linked data"
- "controlled vocabulary"
- "ontology"
- "RDF"
- "OWL"
- "IIIF"
version: "0.1.0"
date-released: 2021-03-12
repository-code: https://github.com/LINNAE-project/SFB-Annotator
license: Apache-2.0
GitHub Events
Total
Last Year
Dependencies
- ch.qos.logback:logback-classic 1.0.13
- com.github.jsonld-java:jsonld-java 0.10.0
- com.googlecode.json-simple:json-simple 1.1.1
- commons-io:commons-io 2.5
- javax.servlet:jstl 1.2
- javax.servlet:servlet-api 3.0-alpha-1
- org.apache.httpcomponents:httpcore 4.4.5
- org.apache.tiles:tiles-extras 3.0.4
- org.eclipse.rdf4j:rdf4j-repository-sparql 3.5.0
- org.eclipse.rdf4j:rdf4j-runtime 3.5.0
- org.json:json 20160810
- junit:junit 3.8.1 test
- jq *
- matplotlib *
- networkx *
- rdflib *
- tripoli *
- actions/checkout v2 composite
- actions/setup-python v1 composite
- jinja2
- jupyter 1.0.0.*
- pip
- rdflib 5.0.0.*
- eclipse/rdf4j-workbench amd64-3.2.0-M2 build
- clariah/grlc latest
- linnae/cantaloupe latest
- linnae/mirador latest
- linnae/sfb-annotator latest