Requirements:

Python 3 (64 bit)

the package dependencies are in the requirements.txt file Java CoreNLP (Instructions in Sentiment Readme)

Initial Set Up Windows

1 Go to Python.org

• Click Downloads tab
• Click Download Windows x86-64 executable installer

2 Open/run the downloaded executable

• Click the checkbox to add Python 3.7 to path
• click install now
• After completing the installation the window can now be closed

3 Locate where the sentiment.py file is located

4 Move the lexicon file and data file to be in the same directory (aka folder) as the sentiment.py file

5 Open the cmd prompt

• in the windows search bar type in cmd and it should be clickable

6 In the command prompt navigate to where the sentiment.py, lexicon, and data files are located

• if the file was located in Downloads cd Downloads

7 There is a provided requirements.txt file that comes with the sentiment.py package to make it easier to install required dependencies

• This should be done only once before you can run the sentiment analysis
• In the command prompt you should enter pip install -r requirements.txt

8 with all the dependencies install you are now able to run the sentiment analysis with the semantics above

Seting up Java and CoreNLP

In order to run the sentiment analysis package you will need the CoreNLP package and Java installed. We have created a Powershell scirpt that will install and setup both of these depencies for you. The Instructions below will show you how to use this script.

This command will take a few minuts.

1 Open Power Shell as Administrator

Go to the home menu and search for Powershell. Next right click and select run and administrator.

2 Navigate to the project path

3 Run the Script

Once you are at the root of the project type .\orcassetup.ps1. This command will likely ask you a few questions respond Yes to these prompts and make take a few minuts to run. Once this script is done running you will be ready to use the CoreNLP service.

Download CoreNLP with out setting up java

If you've already set up Java and want to downlaod the CoreNLP tool we've create a script to download and unzip this code for you in the correct location. Run the following to install this tool:

.\downloadnlp.ps1

Initial Setup MacOS

Install Brew

Follow the instructions here[https://brew.sh/] to install brew. Check that brew is installed by running brew -v in the terminal. you should get something similar to the below.

10-249-96-112:OrcasAnalysis engineeringuser$ brew -v
Homebrew 2.1.13
Homebrew/homebrew-core (git revision 3658; last commit 2019-10-09)
Homebrew/homebrew-cask (git revision 4ac53; last commit 2019-10-09)

Install Python 3

Before trying to install python check which version of python you are running by running python -V in the terminal. You should get the following out put:

Python 2.7.15

If you get a version 3.x.x you should be good to go and shouldn't need to install python3.

If you get 2.x.x you will need to install python3.

To install python3 run the following command in the terminal

brew install python3

To ensure python3 is installed type python3 -V into the terminal. You should get Python 3.x.x as output from this command.

Running the project

Follow the same usage instructions above for windows only replace python with python3 in all the commands. You will also need to replace pip with pip3 in the instructions above as well.