Skip to content

ETCBC/shebanq-local

Repository files navigation

SHEBANQ

Project Status: Active – The project has reached a stable, usable state and is being actively developed.

shebanq tf etcbc

Status

The days of shebanq.ancient-data.org as a website are numbered.

At some point in the (near) future shebanq will be shut down.

However, all public data in it has been curated and this repo makes it available to you.

You can run shebanq on your own computer for personal use, with the latest data loaded.

You can find here the metadata of all lexemes.

You can find here the metadata of all published queries.

You can download the results of all published queries and view them in the Text-Fabric browser.

Caution

Do not deploy this version of SHEBANQ on a server.

Some security features are switched off (email verification) and the admin password for the web framework, Wep2Py, is in plain sight in the .env file.

This deployment is meant for personal computers, where SHEBANQ will run on localhost.

About

System for HEBrew Text: ANnotations for Queries and Markup

SHEBANQ was, until ??-??-20?? a website with a search engine for the Hebrew Bible, powered by the BHSA linguistic database, also known as ETCBC or WIVU.

The ETCBC is lead by prof. dr. Willem Th. van Peursen.

History

SHEBANQ was first deployed in 2014, by DANS, for the ETCBC, in the context of CLARIN.

The evolution of SHEBANQ till now can be seen in ETCBC/shebanq which reflects the history of SHEBANQ since October 2017. It still contains the documentation and lots of useful information.

As of 2023-12-21 SHEBANQ migrated to KNAW/HuC in the context of CLARIAH, which acts as the successor of CLARIN.

On 2026-03-01 the maker of SHEBANQ, retired. This repository is a curated version of SHEBANQ. It contains the resources to set up a local shebanq on your computer which contains all the public material that users have contributed over time until the moment of curation.

Local deployment

These are the steps to get your own shebanq. If something goes wrong, consult the trouble. For more information about how you can use and maintain your own shebanq, see the FAQ.

If you are a developer, see also FAQ-dev.

  1. Install a docker engine that is capable of multi-platform builds, we recommend Docker Desktop.

  2. Start a bash shell and verify that it can do the git command

    git --version
    
  3. Clone this repository:

    cd to/your/directory/of/choice
    git clone https://github.com/ETCBC/shebanq-local.git
    cd shebanq-local
    
    
  4. Start the local shebanq server by

    ./shebanq.sh up
    

    (which is an abbreviation for docker compose up)

  5. Open a bash shell in the same directory and do

    ./shebanq.sh browse
    

    and now a browser window opens with the shebanq website in it.

Inspect query results in the TF browser

Without setting up your own local shebanq, you can still view the results of published queries in the Text-Fabric browser. These are the steps to do that:

  1. Install Python

  2. Install Text-Fabric by

    pip install 'text-fabric[all]'
    
  3. Download the results of the public queries in Text-Fabric format. This will end up in your Downloads folder (assuming ~/Downloads)

  4. Start the TF browser and load the query results:

    tf ETCBC/bhsa --sets=~/Downloads/qresults.tfx
    
  5. In the search box, enter the id and version of a query.

    queries in tf

Author

Dirk Roorda, working at KNAW Humanities Cluster - Digital Infrastructure.

See team for a list of people that have contributed in various ways to the existence of the website SHEBANQ.

About

A curated shebanq designed for local use

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published