TopoLogic

Yet Another Topic Modeling Browser...

Originally based off https://github.com/AdrienGuille/TOM with many changes and enhancements and tied to PhiloLogic

INSTALLATION

While you can build and install TopoLogic directly, it is highly encouraged to use a Docker container instead.

Docker install

Note that the docker container will come with PhiloLogic 4.7 pre-installed. You will need to build PhiloLogic databases within the container before running TopoLogic

• Just run docker build -t topologic . to build the image
• Then run docker run -td --name topologic topologic init_topologic to initialize the container. You may want to specify ports for web passthrough (e.g. -p 8080:80 to map port 8080 on the host to port 80 on the container)
• Once the container is running, enter the container with docker exec -it topologic bash.
• Note that if you need to install SpaCy models, you will need to enter the topologic virtual environment like so: source /var/lib/topologic/topologic_env/bin/activate

Manual installation

• PostgreSQL will need to be installed. You will need to create a database with associated user with read and write permissions.
• You will need to edit the /etc/topologic/global_settings.ini file with the database information and web configuration.
• You will need a running instance of PhiloLogic4 with the collections to be processed already loaded.
• Run the install.sh script
• If you OS uses systemd for start-up services, you will want to use the topologic.service file (template for Ubuntu provided as an example) located in api_server/topologic.service to start-up the API server needed to run Topologic
• The installation includes the Gunicorn webserver which is used to run the TopoLogic web app. You will need to start the server from a shell script installed in /var/lib/topologic/api_server/. This wil require some configuring in the shell script depending on your setup.

HOW TO USE

• Make a copy of the topologic_config.ini file found in /var/lib/topologic/config to your working directory, Edit the topologic_config.ini accordingly.
• Use the topologic executable while passing the config and the number of workers to use. E.g.

topologic --config=topologic_config.ini --workers=32

NOTE

If you run out of memory when processing the text files, use fewer cores. This will lower the chance the data accumulates in RAM while waiting to be written out to disk.