Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README #96

Closed
wants to merge 2 commits into from
Closed

README #96

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d3ce1e2
README fixed
D063520 Oct 17, 2019
4e44f7d
Chnaged main readme slightly
D063520 Oct 17, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 0 additions & 57 deletions README
View file
Open in desktop

This file was deleted.

49 changes: 28 additions & 21 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,50 +1,57 @@
[![Join the chat at https://gitter.im/rdfhdt](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/rdfhdt)
HDT Library, Java Implementation. http://www.rdfhdt.org

# HDT Library, Java Implementation. http://www.rdfhdt.org

## Overview
Overview
================

HDT-lib is a Java Library that implements the W3C Submission (http://www.w3.org/Submission/2011/03/) of the RDF HDT (Header-Dictionary-Triples) binary format for publishing and exchanging RDF data at large scale. Its compact representation allows storing RDF in fewer space, providing at the same time direct access to the stored information. This is achieved by depicting the RDF graph in terms of three main components: Header, Dictionary and Triples. The Header includes extensible metadata required to describe the RDF data set and details of its internals. The Dictionary organizes the vocabulary of strings present in the RDF graph by assigning numerical IDs to each different string. The Triples component comprises the internal structure of the RDF graph in a compressed form.

It provides several components:
- hdt-java-api: Abstract interface for dealing with HDT files.
- hdt-java-core: Core library for accessing HDT files programmatically from java. It allows creating HDT files from RDF and converting HDT files back to RDF. It also provides a Search interface to find triples that match a specific triple pattern.
- hdt-java-cli: Commandline tools to convert RDF to HDT and access HDT files from a terminal.
- hdt-java-cli: Commandline tools to convert RDF to HDT, merge two HDT files and access HDT files from a terminal.
- hdt-jena: Jena integration. Provides a Jena Graph implementation that allows accessing HDT files as normal Jena Models. In turn, this can be used with Jena ARQ to provide more advanced searches, such as SPARQL, and even setting up SPARQL Endpoints with Fuseki.
- hdt-java-package: Generates a package with all the components and launcher scripts.
- hdt-fuseki: Packages Apache Jena Fuseki with the HDT jars and a fast launcher, to start a SPARQL endpoint out of HDT files very easily.


## Compiling
Compiling
===============

Use `mvn install` to let Apache Maven install the required jars in your system.
Use mvn install to let Apache Maven install the required jars in your system.

You can also run `mvn assembly:single` under hdt-java-package to generate a distribution directory with all the jars and launcher scripts.
You can also run mvn assembly:single under hdt-java-package to generate a distribution directory with all the jars and launcher scripts.


## Usage
Usage
===============

Please refer to hdt-java-package/README for more information on how to use the library. You can also find useful information on our Web Page http://www.rdfhdt.org


## License
License
===============

Each module has a different License. Core is LGPL, examples and tools are Apache.

* `hdt-api`: Apache License
* `hdt-java-cli`: (Commandline tools and examples): Apache License
* `hdt-java-core`: Lesser General Public License
* `hdt-jena`: Lesser General Public License
* `hdt-fuseki`: Apache License
hdt-api: Apache License
hdt-java-cli (Commandline tools and examples): Apache License
hdt-java-core: Lesser General Public License
hdt-jena: Lesser General Public License (licenses for tests in test suite vary, see individual LICENSE files)
hdt-fuseki: Apache License


## Authors
Authors
===============

* Mario Arias <mario.arias@gmailcom>
* Javier D. Fernandez <[email protected]>
* Miguel A. Martinez-Prieto <[email protected]>
Mario Arias <mario.arias@gmailcom>
Javier D. Fernandez <[email protected]>
Miguel A. Martinez-Prieto <[email protected]>
Dennis Diefenbach <[email protected]>
Jose Gimenez Garcia: <[email protected]>

[contributors](https://github.com/WDAqua/Trill/graphs/contributors)

## Acknowledgements
Acknowledgements
================

RDF/HDT is a project developed by the Insight Centre for Data Analytics (www.insight-centre.org), University of Valladolid (www.uva.es), University of Chile (www.uchile.cl). Funded by Science Foundation Ireland: Grant No. SFI/08/CE/I1380, Lion-II; the Spanish Ministry of Economy and Competitiveness (TIN2009-14009-C02-02); and Chilean Fondecyt's 1110287 and 1-110066.
RDF/HDT is a project developed by the Insight Centre for Data Analytics (www.insight-centre.org), University of Valladolid (www.uva.es), University of Chile (www.uchile.cl), University of Saint-Etienne (www.univ-st-etienne.fr). Funded by Science Foundation Ireland: Grant No. SFI/08/CE/I1380, Lion-II; the Spanish Ministry of Economy and Competitiveness (TIN2009-14009-C02-02); Chilean Fondecyt's 1110287 and 1-110066; and the European Union's Horizon 2020 research and innovation program under the Marie Sklodowska-Curie grant agreement No 642795.