HoPRe: Homophone-based Pun Recognition

HoPRe is a pun-recognition software based on first-order logic and lambda calculus.

Installation

All instructions below have only been tested with Ubuntu 20.04.6 LTS, specifically using WSL2 on Windows 10. Please adapt and improvise along the way.

1. Clone this repository.

   git clone https://github.com/pingpingy1/HoPRe.git
   cd HoPRe

2. Download SWI-Prolog. (Help)

   sudo apt-add-repository ppa:swi-prolog/stable
   sudo apt update
   sudo apt install swi-prolog
   swipl --version

3. Create and activate a Python virtual environment.

   pyenv virtualenv 3.10.7 hopre3107
   pyenv local hopre3107

4. Install required packages.

   python setup.py

5. Run HoPRe.

   python -m hopre.core           # Take user input
   python -m hopre.core -t        # Run test suites