treelets
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
treelets [2019/12/12 21:00] – [Setup Treelets from a binary distribution] pwilk | treelets [2019/12/23 12:38] – madamczyk | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Treelets Documentation ====== | ====== Treelets Documentation ====== | ||
- | This page contains the documentation of the Treelets phraseology extraction tool. | + | This page contains the documentation of the Treelets phraseology extraction tool. The main topics covered here include: |
+ | |||
+ | * Configuring and running the Treelets docker container including the Postgres database, Java API, angular web application, | ||
+ | * Parsing and indexing corpora, generating and searching automatic combinatorial dictionaries extracted with Treelets | ||
+ | |||
+ | Any issues related to Treelets should be reported to the contact[at]pelcra.pl. | ||
===== Docker Installation ===== | ===== Docker Installation ===== | ||
- | Detailed instruction on how to install | + | Treelets |
- | ===== Learning Outcomes ===== | + | |
- | | + | * [[Linux Mint]] |
- | * Have a configured local Treelets web application on one machine | + | * [[MacOS 10.15 Catalina]] |
- | * Learned how to understand and configure Treelets Docker configuration including api, database, angular, nginx etc. | + | * [[Windows 10 Professional]] |
- | * Search Indexed data in Your application | + | * [[Windows 10 Home]] |
- | Any issues with this tutorial should be reported to the contact[at]pelcra.pl list. | + | |
===== Requirements ===== | ===== Requirements ===== | ||
- | * Unix environment, | + | * Linux environment, |
- | * Docker Desktop for Windows 10 Professional or Mac OS | + | * Docker Desktop for Windows 10 Professional or MacOS |
* Docker Toolbox on Windows 10 Home | * Docker Toolbox on Windows 10 Home | ||
- | ===== Install Treelets on Ubuntu ===== | + | ===== Useful |
- | ==== Install | + | |
- | * # run in Linux bash install commands: | + | |
- | < | + | |
- | sudo apt install docker | + | |
- | sudo apt install docker-compose | + | |
- | sudo apt install postgresql-client-common | + | |
- | </ | + | |
- | * # check docker version commands: | + | |
- | < | + | |
- | sudo docker -v | + | |
- | sudo docker-compose -v | + | |
- | </ | + | |
- | + | ||
- | ==== Setup Treelets from a binary distribution ==== | + | |
- | * Download treelets-docker application for Ubuntu {{ : | + | |
- | * Unzip | + | |
- | * Run bash and go inside treelets-docker catalog | + | |
- | + | ||
- | ==== Run Docker ==== | + | |
- | * # run in Linux bash commands: | + | |
- | < | + | |
- | # Build | + | |
- | sudo docker-compose build | + | |
- | + | ||
- | # Running | + | |
- | sudo docker-compose up -d | + | |
- | + | ||
- | # View instances | + | |
- | sudo docker-compose ps | + | |
- | </ | + | |
- | + | ||
- | ===== Install Treelets on Windows 10 Home ===== | + | |
- | + | ||
- | ==== Install Docker Toolbox ==== | + | |
- | * Install the application using the tutorial: [[https:// | + | |
- | + | ||
- | ==== Setup Treelets from a binary distribution ==== | + | |
- | * Download treelets-docker application for Windows 10 Home {{ :: | + | |
- | * Unzip | + | |
- | * Run Docker Quickstart Terminal from Desktop and go inside treelets-docker catalog | + | |
- | + | ||
- | ==== Run Docker ==== | + | |
- | * # run in Docker Quickstart Terminal command and note ip, it will be used to open application | + | |
- | < | + | |
- | # get default ip for application | + | |
- | docker-machine ip default | + | |
- | </ | + | |
- | + | ||
- | * # using windows explorer go to the file treelets-docker\app\webapp\assets\config\api.json | + | |
- | < | + | |
- | # change webSocketHost address to docker-machine ip default eg. | + | |
- | " | + | |
- | </ | + | |
- | + | ||
- | * # run install commands: | + | |
- | < | + | |
- | # create a volume | + | |
- | docker volume create postgres_database | + | |
- | + | ||
- | # check volumes | + | |
- | docker volume ls | + | |
- | + | ||
- | # Build | + | |
- | docker-compose build | + | |
- | + | ||
- | # Running | + | |
- | docker-compose up -d | + | |
- | + | ||
- | # View instances | + | |
- | docker-compose ps | + | |
- | </ | + | |
- | + | ||
- | ===== Verify your Treelets installation ===== | + | |
- | * Open your favourite Browser and type: http:// | + | |
- | * On Windows 10 Home use the IP specified during installation: | + | |
- | + | ||
- | + | ||
- | ===== Docker useful | + | |
< | < | ||
Line 117: | Line 43: | ||
exit | exit | ||
| | ||
- | # Stop | + | # Stop docker containers |
sudo docker-compose stop | sudo docker-compose stop | ||
| | ||
- | # Remove | + | # Remove |
sudo docker-compose down | sudo docker-compose down | ||
</ | </ | ||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- |
treelets.txt · Last modified: 2019/12/26 01:55 by pkowalczyk