stella-search

A search interface that connects to the STELLA infrastructure

https://github.com/stella-project/stella-search

Science Score: 44.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
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.6%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

A search interface that connects to the STELLA infrastructure

Basic Info
  • Host: GitHub
  • Owner: stella-project
  • License: gpl-3.0
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 12.5 MB
Statistics
  • Stars: 0
  • Watchers: 6
  • Forks: 1
  • Open Issues: 1
  • Releases: 0
Created over 6 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

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.

  • Clone STELLA Search: git clone https://github.com/stella-project/stella-search.git && cd stella-search && git checkout 0bfc0f9ec17d80a1f4287409adce8f9ee94f1a52 && cd ..

  • Clone the STELLA app: git clone https://github.com/stella-project/stella-app.git && cd stella-app && git checkout 0686a402103e9e8db8eb3268886aac1f6cc7aff6 && cd ..

  • Clone the STELLA server: 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: site_a@stella.org
    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.

Owner

  • Name: STELLA - Infrastructures for Living Labs
  • Login: stella-project
  • Kind: organization

Citation (CITATION.cff)

# YAML 1.2
---
abstract: "STELLA search is a minimal front-end that is used to showcase the idea of the STELLA infrastructure. It offers access to results from the STELLA app and, likewise, sends feedback to it. It includes a search field, a dynamic list of found results and a detail view with recommendations."
authors: 
  -
    affiliation: "TH Köln - University of Applied Sciences, Germany"
    family-names: Schaer
    given-names: Philipp
    orcid: "https://orcid.org/0000-0002-8817-4632"
  -
    affiliation: "GESIS - Leibniz Institute for the Social Sciences, Germany"
    family-names: Schaible
    given-names: Johann
    orcid: "https://orcid.org/0000-0002-5441-7640"
  -
    family-names: "Garcia Castro"
    given-names: "Leyla Jael"
    orcid: "https://orcid.org/0000-0003-3986-0510"
  -
    family-names: Breuer
    given-names: Timo
    orcid: "https://orcid.org/0000-0002-1765-2449"
  -
    family-names: Tavakolpoursaleh
    given-names: Narges
    orcid: "https://orcid.org/0000-0001-9324-3252"
  -
    family-names: Wolff
    given-names: Benjamin
    orcid: "https://orcid.org/0000-0001-9345-8958"
cff-version: "1.1.0"
date-released: 2020-09-21
keywords: 
  - "Living Lab"
  - "Evaluation Infrastructure"
  - "Shared Task"
license: MIT
message: "If you use this software, please cite it using these metadata."
title: "STELLA Search"
version: "0.1"
...

GitHub Events

Total
  • Push event: 8
  • Pull request review event: 10
  • Pull request review comment event: 6
  • Pull request event: 2
  • Create event: 2
  • Commit comment event: 2
Last Year
  • Push event: 8
  • Pull request review event: 10
  • Pull request review comment event: 6
  • Pull request event: 2
  • Create event: 2
  • Commit comment event: 2

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 0
  • Total pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: 18 days
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: 18 days
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • mdenizturkmen (1)
Top Labels
Issue Labels
Pull Request Labels