2021-01-04 09:35:31 +01:00
|
|
|
# Hyperboria
|
|
|
|
|
|
|
|
|
|
## Introduction
|
|
|
|
|
|
|
|
|
|
Hyperboria repository is a pack of tools for dealing with SciMag and SciTech collections.
|
|
|
|
|
|
2021-01-29 09:18:22 +01:00
|
|
|
It consists of configurable [`search engine`](nexus/cognitron), [`pipeline`](nexus/pipe) for [`ingesting`](nexus/ingest) data
|
2021-01-04 09:35:31 +01:00
|
|
|
from upstream sources. So-called [`actions`](nexus/actions) aimed to converting data from external APIs
|
|
|
|
|
into [`internal Protobuf format`](nexus/models) and to landing converted data into databases and/or search engines.
|
|
|
|
|
|
|
|
|
|
## Prerequisite
|
|
|
|
|
|
2021-04-23 17:23:02 +02:00
|
|
|
Install system packages for various OSes:
|
|
|
|
|
```shell script
|
|
|
|
|
sudo ./repository/install-packages.sh
|
|
|
|
|
```
|
|
|
|
|
|
2021-01-04 09:35:31 +01:00
|
|
|
### Ubuntu 20.04
|
|
|
|
|
|
|
|
|
|
#### Docker
|
|
|
|
|
[Installation Guide](https://docs.docker.com/engine/install/ubuntu/)
|
|
|
|
|
|
2021-01-29 09:36:47 +01:00
|
|
|
#### IPFS
|
|
|
|
|
[Installation Guide](https://docs.ipfs.io/install/)
|
|
|
|
|
|
2021-01-04 09:35:31 +01:00
|
|
|
### MacOS
|
|
|
|
|
|
|
|
|
|
#### Docker
|
|
|
|
|
[Installation Guide](https://docs.docker.com/docker-for-mac/install/)
|
|
|
|
|
|
2021-01-29 09:36:47 +01:00
|
|
|
#### IPFS
|
|
|
|
|
[Installation Guide](https://docs.ipfs.io/install/)
|
|
|
|
|
|
2021-01-04 09:35:31 +01:00
|
|
|
## Content
|
|
|
|
|
|
|
|
|
|
- [`images`](images) - base docker images for [`nexus`](nexus)
|
|
|
|
|
- [`library`](library) - shared libraries
|
|
|
|
|
- [`nexus`](nexus) - processing and searching in scientific text collections
|
|
|
|
|
- [`rules`](rules) - build rules
|
