Skip to content

A Quick Start

Natalie Prange edited this page Nov 20, 2024 · 2 revisions

For a quick setup of ELEVANT please follow these steps:

  1. Get the code
git clone https://github.com/ad-freiburg/elevant.git .
  1. Go to the ELEVANT directory, create a data directory and set the necessary permissions:
cd elevant
mkdir data
chmod a+rw -R data/ evaluation-results/ benchmarks/
  1. Build and start the docker container:
docker build -t elevant .
docker run -it -p 8000:8000 -v $(pwd)/data/:/data -v $(pwd)/evaluation-results/:/home/evaluation-results -v $(pwd)/benchmarks/:/home/benchmarks elevant
  1. Within the docker container, download the necessary data (~10GB compressed, ~28GB uncompressed):
make download_all
  1. Start the web app:
make start_webapp

You can then access the webapp at http://0.0.0.0:8000/ and inspect pre-computed linker results. Note that you do not have to download the mappings in step 4) in order to inspect these results, but you do need them to add your own experiments or benchmarks.

Next Steps

Having successfully set up ELEVANT, you might want to add an experiment or add a new benchmark.

Further Reading

  • For instructions on how to set up ELEVANT without using Docker, see Setup Without Docker.
  • For a description of the mapping files used by ELEVANT, see Mapping Files.
  • For instructions on how to generate the mapping files yourself, see Generating Data.