https://github.com/centre-for-humanities-computing/classic-topic

Web application for dynamic topic modelling on classical texts in the "Computing antiquity" project
https://github.com/centre-for-humanities-computing/classic-topic

Last synced: about 1 year ago
JSON representation

Web application for dynamic topic modelling on classical texts in the "Computing antiquity" project

• Host: GitHub
• URL: https://github.com/centre-for-humanities-computing/classic-topic
• Owner: centre-for-humanities-computing
• License: mit
• Created: 2022-10-05T09:59:15.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-28T09:23:48.000Z (about 3 years ago)
• Last Synced: 2025-04-19T21:25:34.507Z (about 1 year ago)
• Language: Python
• Size: 290 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Topiquity

[![Code style: black](https://img.shields.io/badge/Code%20Style-Black-black)](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html)

[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)

[![Docker](https://badgen.net/badge/icon/docker?icon=docker&label)](https://https://docker.com/)

[![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/)

Web application for dynamic topic modelling on classical texts in the "Computing antiquity" project.

![Screenshot](./assets/screenshot.png)

## Setup

In order for the application to run properly you will need a `dat/cleaned_corpus.csv` in the working directory. 


This file has to contain a table with one column being `id_nummer` containing the IDs of the texts,

the other being `text` containing a whitespace-separated cleaned texts. 


### Debugging

For debugging purposes (or if you're just lazy to mess with docker) you may run the app by installing dependencies:

```bash

pip install -r requirements.txt

```

Then run the main script in the following fashion:

```bash

cd src && python3 main.py

```

The server will listen at `localhost:8080`, you are free to open it up in your browser.

### Deployment

Both a Dockerfile and a docker compose default configuration is included in the repository, these might aid you in deploying the application to a webserver of some sorts, or just run the app on your computer in an isolated environment.

It's easiest to get started by running the app in docker compose:

```bash

docker compose up

```

This will spin up a container and attach to `localhost:7011`

## Known limitations

- DMM and LSI don't work particularly well, sometimes not at all, you should use LDA or NMF as things stand right now. A project-agnostic topic investigation platform might be developed in the near future.

- The code is heavily project-specific, if you want to use the application with a different corpus you will have to dig deep into the code.