treelets
This is an old revision of the document!
Table of Contents
Treelets Documentation
This page contains the documentation of the Treelets phraseology extraction tool.
The main topics covered here include:
- Configuring and running the Treelets docker container, which includes the Postgres database, Java API, angular web application, nginx server etc.
- 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
Treelets can be installed locally as a Docker container on any major operating system.
The installation process varies for different operating systems. The following pages explain how to install Treelets on:
Requirements
- Unix environment, Windows 10 Home or Professional, Mac OS environment
- Docker Desktop for Windows 10 Professional or Mac OS
- Docker Toolbox on Windows 10 Home
Install Treelets on Ubuntu
Install Docker
- # 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 treeletsdocker_ubuntu_2019_12_10.zip
- 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://docs.docker.com/toolbox/toolbox_install_windows/
Setup Treelets from a binary distribution
- Download treelets-docker application for Windows 10 Home treeletsdocker_w10home_2019_12_08.zip
- 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. "webSocketHost": "ws://192.168.99.100:4221/notifications"
- # 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://localhost:8080
- On Windows 10 Home use the IP specified during installation: http://192.168.99.100:8080
Docker useful commands
# View instances with container id sudo docker ps # Logs sudo docker-compose logs # Monitoring sudo docker stats # Connect sql command sudo docker exec -it {container_id} sh psql -U treelets treelets select * from info.config; select version(); \q exit # Stop sudo docker-compose stop # Remove sudo docker-compose down
treelets.1576492353.txt.gz · Last modified: 2019/12/16 11:32 by pezik