Amsterdam Content Analysis Toolkit
HTML Python JavaScript CSS Shell R Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

AmCAT - Amsterdam Content Analysis Toolkit

Master: Build Status Release 3.4: Build Status

Experimental Docker Support

We've created a Dockerfile and docker-compose.yml file that should allow you to automatically run AmCAT and all dependencies with Docker. See amcat/amcat-docker

Installation instructions for 3.4 (stable)

The installation instructions for AmCAT 3.4 (the last stable release) can be found here

Installation and Configuration for development version

The following instructions are for the (unstable) development version. To install stable releases, please use the link above.

Prerequisites

Most of the (python) prerequisites for AmCAT are automatically installed using pip (see below). To install the non-python requirements, you can use the following (on Ubuntu 15.10 or 16.04):

sudo apt-get install antiword unrtf rabbitmq-server python3-pip postgresql postgresql-contrib python3-venv git postgresql-server-dev-9.5 python3-dev libxml2-dev libxslt-dev graphviz pspp redis-server r-base python3-lxml python3-amqplib python3-psycopg2 python3-requests python3-pygments docker.io nodejs-legacy npm

Installing AmCAT

Clone the project from github and pip install the requirements.

(Note: We usually create a virtual environment within the amcat folder and use env/bin/python instead of activating the envirtonment, but of course you can change that if you wish)

git clone https://github.com/amcat/amcat.git
cd amcat
pyvenv env
env/bin/pip install wheel -r requirements.txt

Note: at the time of writing, the latest dateparser release (v0.6.0) contains a severe performance bug. If this proves to be a problem, install from: https://github.com/CJStuart/dateparser@v0.6.0-patch0

Elastic

AmCAT uses elasticsearch for searching articles. The easiest way to install elastic is through docker.

Development:

For development only, the easiest way to run docker is by running the following:

docker run --name elastic -dp 9200:9200 -e "discovery.type=single-node" amcat/amcat-elastic-docker:5.4.3

This is fine for testing/developing, but absolutely not suitable for production use!

Note: if you do not have permission to run docker, it might be necessary to add yourself to the docker group. Run sudo usermod -aG docker $USER and log out and back in.

Production:

For production, install elastic normally, preferably on more than 1 node, or see https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html for more information on installing elastic through docker on production systems.

For configuring elastic for AmCAT, see the Dockerfile

Setting up the database

Whichever way you installed AmCAT, you need to call the migrate command to populate the database and set the elasticsearch mapping:

sudo -u postgres createuser -s $USER
createdb amcat
env/bin/python -m amcat.manage migrate

You can create a superuser by running:

env/bin/python -m amcat.manage createsuperuser

Collecting static files

AmCAT uses bower to install javascript/CSS libraries. Install bower by using npm, and then run bower install from the amcat folder:

sudo npm install -g bower
bower install

Start AmCAT web server

For debugging, it is easiest to start amcat using runserver:

env/bin/python -m amcat.manage runserver

Start celery worker

Finally, to use the query screen you need to start a celery worker. In a new terminal, type:

env/bin/python -m amcat.manage celery worker -l info -Q amcat

(if you are using a virtual environment, make sure to activate that first)

Configuring AmCAT

The main configuration parameters for AmCAT reside in the settings folder. In many places, these settings are defaults that can be overridden with environment variables.