The NLP Suite Runner is the new, official tool to install and run the NLP Suite. The NLP Suite Runner is a binary that automatically installs 3 main packages:
- NLP Suite UI: the user interface to interact with the NLP Suite Agent
- NLP Suite Agent: the core algorithms and tools provided by the NLP Suite
- Stanford CoreNLP: a dependency needed to run the NLP Suite
The NLP Suite Runner requires to download and install Docker Desktop.
To install the NLP Suite, Docker desktop requires at least 4GB of RAM. The NLP Suite Runner strongly encourages that you have at least 10 GB of storage available.
To install the NLP Suite Runner, first ensure that you have downloaded and installed Docker Desktop.
You can download the proper NLP Suite via Docker executable for your operating system in the latest release here.
The executable will be downloaded and placed to a location of your choice. The executable (nlp-suite-runner.exec) will look like this: 
To run GIS (Geographic Information System) mapping via Google Earth Pro, rather than the default Python Folium, you need to download and install Google Earth Pro; click here to download Google Earth Pro.
To display network graphs via Gephi, you need to download and install Gephi; click here to download Gephi.
-# Mac
Mac and Linux systems can easily extract .tar.gz files without additional tools.
If you have a mac running the ARM M-chip series, ensure that you install the darwin-arm64 version of the NLP Suite Runner.
If you have the Intel chip, you will need to install the darwin-amd64 version of the NLP Suite Runner.
To extract the runner, you will need 7-zip, a file archiver tool for Windows.
You most likely will need to install the windows-amd64 version of the NLP Suite Runner.
If your device has an ARM chip, ensure you have windows-arm64 installed. To check which version you have, check here.
To run the NLP Suite Runner, double click the binary/exe.
You must first start Docker Desktop by clicking on the Docker app wherever you installed on your computer.
It is required to run the NLP Suite Runner.
When the runner starts, cpy the address on an open brower to visualize the NLP Suite
Click on the NLP tool you wish to run, e.g., Sentiment analysis
The input and output directories are disabled. You cannot change the values.
So... how can yyou change those directories? See, below the section Input / Output Directories
You may see an error indicating that the NLP Suite Runner cannot be opened because it is not coming from a trusted source. This is expected to occur the first time you run the NLP Suite Runner. To start the runner, follow these instructions to allow the NLP Suite Runner to open.
There are no known issues for starting and running the NLP Suite Runner at this time.
Currently, the input and output directories are hard coded. DO NOT TRY ALTER THE INPUT AND OUTPUT PATHS.
For Mac users, the folder is located in your home folder. The home folder may not directly appear in your Finder. To convinently add your home folder to Finder, use these instructions.
For Windows users, the two Input & Output folders are automatically installed for you in your Users: folder.
For instance rfranzo and within it nlp-suite
The path would be C:\Users\rfranzo\nlp-suite
Make sure that your corpus files are uploaded into the input directory (e.g., C:\Users\rfranzo\nlp-suite\input) and not inside a sub-folder of this directory.
While the NLP Suite Runner automatically updates the installed packages mentioned above, the NLP Suite Runner does not automatically update itself. Periodically check this page to ensure you have the latest version installed.
If there are any issues you are encountering, header over to Issues to open a ticket.
If you would like to contribute to the NLP Suite, please contact Roberto Franzosi