Legacy Lakesuperior code.

Stefano Cossu d104bad0a9 Update benchmark info.		6 yıl önce
data	dc50b0a51d Make extract_imr compatible with bdb back end; add RDF types for resource graphs.	6 yıl önce
doc	d104bad0a9 Update benchmark info.	6 yıl önce
etc.skeleton	6498205eb5 Move stuff for Python API; lots of cleanup here and there.	6 yıl önce
lakesuperior	bca8cbc363 Avoid double-wrapping depete method in transaction; remove redundant	6 yıl önce
static	4090e51570 SPARQL query UI and API.	6 yıl önce
tests	bca8cbc363 Avoid double-wrapping depete method in transaction; remove redundant	6 yıl önce
util	ad9f67b4bf Move bootstrap to admin CLI; add other method stubs.	6 yıl önce
.gitignore	2fdc1b902e Initial commit: some boilerplate borrowed from Combine, basic folder structure and documentation.	6 yıl önce
LICENSE	2fdc1b902e Initial commit: some boilerplate borrowed from Combine, basic folder structure and documentation.	6 yıl önce
README.md	a800fda3c3 Adjust requirements and README.	6 yıl önce
conftest.py	6980366c72 Separate environments between inside and outside app context.	6 yıl önce
fcrepo	85d7c968e7 Remove Bjoern; update docs.	6 yıl önce
lsup-admin	b968f5a8ee Add stub CLI methods; update documentation.	6 yıl önce
profiler.py	8554f845a3 Adapt profiler script to multi-modal access.	6 yıl önce
requirements.txt	a800fda3c3 Adjust requirements and README.	6 yıl önce
server.py	b5c922a8fb Use a global variable rather than thread-local storage for env;	6 yıl önce

LAKEsuperior

LAKEsuperior is an experimental Fedora Repository implementation.

Guiding Principles

LAKEsuperior aims at being an uncomplicated, efficient Fedora 4 implementation.

Its main goals are:

Reliability: Based on solid technologies with stability in mind.
Efficiency: Small memory and CPU footprint, high scalability.
Ease of management: Tools to perform monitoring and maintenance included.
Simplicity of design: Straight-forward architecture, robustness over features.

Key features

Drop-in replacement for Fedora4 (with some caveats); currently being tested with Hyrax 2
Very stable persistence layer based on LMDB and filesystem. Fully ACID-compliant writes guarantee consistency of data.
Term-based search (planned) and SPARQL Query API + UI
No performance penalty for storing many resources under the same container; no kudzu pairtree segmentation ¹
Extensible provenance metadata tracking
Multi-modal access: HTTP (REST), command line interface and native Python API.
Fits in a pocket: you can carry 50M triples in an 8Gb memory stick.

Implementation of the official Fedora API specs (Fedora 5.x and beyond) is not foreseen in the short term, however it would be a natural evolution of this project if it gains support.

Please make sure you read the Delta document for divergences with the official Fedora4 implementation.

Target Audience

LAKEsuperior is for anybody who cares about preserving data in the long term.

Less vaguely, LAKEsuperior is targeted at who needs to store large quantities of highly linked metadata and documents.

Its Python/C environment and API make it particularly well suited for academic and scientific environments who would be able to embed it in a Python application as a library or extend it via plug-ins.

LAKEsuperior is able to be exposed to the Web as a Linked Data Platform server. It also acts as a SPARQL query (read-only) endpoint, however it is not meant to be used as a full-fledged triplestore at the moment.

In its current status, LAKEsuperior is aimed at developers and hands-on managers who are able to run a Python environment and are interested in evaluating this project.

Installation

Dependencies

Python 3.5 or greater.
A message broker supporting the STOMP protocol. For testing and evaluation purposes, CoilMQ is included with the dependencies and should be automatically installed.

Installation steps

Create a virtualenv in a project folder: virtualenv -p <python 3.5+ exec path> <virtualenv folder>
Activate the virtualenv: source <path_to_virtualenv>/bin/activate
Clone this repo
cd into repo folder
Install dependencies: pip install -r requirements.txt
Copy the etc.skeleton folder to a separate location
Set the configuration folder location in the environment: export FCREPO_CONFIG_DIR=<your config dir location> (you can add this line at the end of your virtualenv activate script)
Configure the application if needed. The default settings should be fine for evaluation.
Start your STOMP broker, e.g.: coilmq &. If you have another queue manager listening to port 61613 you can either configure a different port on the application configuration, or use the existing message queue.
Run ./lsup_admin bootstrap to initialize the binary and graph stores
Run ./fcrepo.

Production deployment

If you like fried repositories for lunch, deploy before 11AM.

Status and development

LAKEsuperior is in alpha status. Please see the project issues list for a rudimentary road map.

Contributing

This has been so far a single person's off-hours project (with much input from several sides). In order to turn into anything close to a Beta release and eventually to a production-ready implementation, it needs some community love.

Contributions are welcome in all forms, including ideas, issue reports, or even just spinning up the software and providing some feedback. LAKEsuperior is meant to live as a community project.