Commit 677ce917 authored by leoborn's avatar leoborn
Browse files

Updated READMEs

parent 8d070387
Loading
Loading
Loading
Loading
+59 −0
Original line number Diff line number Diff line
# hch-kg

This repo contains the resources (data and scripts) for the workshop entitled "Providing new views on textual data with knowledge graphs" held at the [2nd Heidelberg Summer School of Computing Humanities](https://hch19.cl.uni-heidelberg.de) on July 19th, 2019 by Juri Opitz and Leo Born.

## Repo structure

* _data/_ contains the untagged -- but annotated -- files of the [Old Bailey Corpus](http://fedora.clarin-d.uni-saarland.de/oldbailey/index.html)
* _output/_ is used as the default output directory for created knowledge graphs
	* _output/gold/_ contains some sample knowledge graphs for the years 1720, 1820, and 1913
* _src/_ contains all scripts
* _visualization/_ contains the visualization suite (see separate README)

## Requirements

Python >3.0 is recommended. This repo was tested on Ubuntu and macOS (10.14).

### Dependencies

Install with pip:

- attrs==19.1.0
- beautifulsoup4==4.7.1
- blis==0.2.4
- chardet==3.0.4
- cycler==0.10.0
- cymem==2.0.2
- decorator==4.4.0
- en-core-web-sm==2.1.0
- idna==2.8
- joblib==0.13.2
- jsonschema==3.0.1
- kiwisolver==1.1.0
- lxml==4.3.4
- matplotlib==3.1.1
- murmurhash==1.0.2
- networkx==2.3
- numpy==1.16.4
- pandas==0.24.2
- plac==0.9.6
- preshed==2.0.1
- pyparsing==2.4.0
- pyrsistent==0.15.3
- python-dateutil==2.8.0
- pytz==2019.1
- requests==2.22.0
- scikit-learn==0.21.2
- scipy==1.3.0
- seaborn==0.9.0
- six==1.12.0
- sklearn==0.0
- soupsieve==1.9.2
- spacy==2.1.4
- srsly==0.0.7
- thinc==7.0.8
- tqdm==4.32.2
- urllib3==1.25.3
- wasabi==0.2.2

**NOTE**: _spacy_ must not be version 2.1.5!

##
 No newline at end of file
+5 −3
Original line number Diff line number Diff line
# How to run the visualization suite
# hch-kg: visualization suite

## Pre-requisites
This directory contains the visualization suite for the workshop ""Providing new views on textual data with knowledge graphs". It is written in JavaScript and based on [Angular JS v1](https://angularjs.org). The main visualization component is based on [visjs](https://visjs.org).

## Requirements
1. Active internet connection as some of the dependencies are loaded via CDNs
2. If you use _Firefox_, just open the file index.html in it
3. If you use a different browser, you need to set up a simple web server; with python for example, you just need to run "python -m SimpleHTTPServer" (python v2) or "python -m http.server" (python v3) in this directory
3. If you use a different browser, you need to set up a simple web server; with Python 3, you just need to run "python -m http.server" in this directory
  *  Per default, this should serve the app on port 8000 of localhost (access via 0.0.0.0:8000 or localhost:8000 in your browser)
 No newline at end of file