Giter VIP home page Giter VIP logo

stella-search's Introduction

STELLA Search

Demo setup of the entire infrastructure

A search interface that connects to the STELLA infrastructure. Queries are conducted to the STELLA app and logged data can be investigated by visiting the dashboard service of the STELLA server.

Demo setup of the entire infrastructure

The following setup guide can be used to get the entire infrastructure running with less than 10 command line calls. Required are installations of docker and docker-compose and the possibility to run docker as a non-root user.

git clone https://github.com/stella-project/stella-search.git && cd stella-search && git checkout 0bfc0f9ec17d80a1f4287409adce8f9ee94f1a52 && cd ..
git clone https://github.com/stella-project/stella-app.git && cd stella-app && git checkout 0686a402103e9e8db8eb3268886aac1f6cc7aff6 && cd ..
git clone https://github.com/stella-project/stella-server.git && cd stella-server && git checkout 054cc2e03faadffb7aada1f94663176fb075fd08 && cd ..
  • Make sure the following ports are available 80,8000, and 8080. The STELLA server will run on port 80, the STELLA app on port 8080 and the STELLA search interface on port 8000.
  • Place the dataset you want to be indexed in data/index in both repositories STELLA search and STELLA app. Per default we use the PubMed snapshot livivo.jsonl from 2015-2016 by LIVIVO. This means, if you are fine with using this data, you do not have to mv/cp/rm anything to/from the data folders (do not touch it!). However, in this case no dataset recommendations can be provided. By using the gesis.jsonl, dataset recommendations are available but only in German. Likewise you can use you own dataset. In order to do so, you have to convert the data into the right format (see also this script).
  • Start the STELLA server first in order to setup a docker network for all containers.
docker-compose -f stella-server/docker-compose.yml up -d
  • Start the STELLA app:
docker-compose -f stella-app/docker-compose.yml up -d

When setting up the STELLA app, the data will be indexed by each system. For these sample datasets this is managable by a laptop. If the datasets get larger, you can start the indexing of single containers by visiting http://0.0.0.0:8080 and clicking the index buttons. Likewise, the indexing can be triggered by API endpoints for either single containers or bulk/parallel indexing.

  • Start STELLA search:
docker-compose -f stella-search/docker-compose.yml up -d
  • Visit http://0.0.0.0:8000 and enter a query, browse, click. As the demo includes a small sample dataset from the medical domain try queries like vaccine, treatment, epidemic.
  • Visit http://0.0.0.0:80, login and visit the dashboard. Use the following credentials for a pre-registered account:
    user: [email protected]
    pass: pass
    Alternatively, you can simulate user interactions with the script provided in the STELLA server repository.

Citation

We provide citation information via the CITATION file. If you use stella-search in your work, please cite our repository as follows:

Schaer P, Schaible J, Garcia Castro LJ, Breuer T, Tavakolpoursaleh N, Wolff B. STELLA Search. Available at https://github.com/stella-project/stella-search/

We recommend you include the retrieval date.

License

stella-search is licensed under the GNU GPLv3 license. If you modify stella-search in any way, please link back to this repository.

stella-search's People

Contributors

breuert avatar ziyad121 avatar jueri avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.