thoppe / openFramingSource

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Introduction

We here propose ABC (real name omitted for the blind review), a Web-based system for analyzing and classifying frames in text documents such as news articles. ABC is designed to lower the barriers to applying machine learning for framing analysis, including giving researchers the capability to build models using their own labeled data. Its architecture is designed to be user-friendly and easily navigable, empowering researchers to comfortably make sense of their text corpora without specific programming experience.

Requirements

Docker

You need Docker. Feel free to read up on Docker if you wish. Our best short explanation for Docker is that, Docker is for deploying applications with complicated dependencies, what the printing press was to publishing books (it allows you to do it in a much quicker, and much more reproducible way).

The link above has guides on how to install Docker on the most popular platforms.

How to install

docker-compose build docker-compose up

You might have to add sudo at the beginning of commands at step 3 and 4 if using linux/macOS.

E-mails

If you want to send actual e-mails through Sendgrid with this system (as opposed to just printing the e-mails that would be sent to the console), please set the environment variables:

export SENDGRID_API_KEY=     # An API key from Sendgrid
export SENGRID_FROM_EMAIL=   # An email address to put in the "from" field. Note that
			     # you'll have to verify this email in Sendgrid as a 
			     # "Sender". 

If you happen to need sudo in the section above, please pass the -E flag to make sure these environment variables are picked up. i.e.,

sudo -E docker-compose up

Acknowledgement

This material is based upon work partially supported by the National Science Foundation under Grant No. 1838193. Any opinions, findings, and conclusions or recommendations expressed in this material are those of the authors and do not necessarily reflect the views of the National Science Foundation.

Getting help

If you have any question, concern, or bug report, please file an issue in this repository's Issue Tracker and we will respond accordingly.

About


Languages

Language:Python 40.6%Language:HTML 37.6%Language:JavaScript 16.4%Language:CSS 3.5%Language:Dockerfile 1.3%Language:SCSS 0.4%Language:Shell 0.0%