Skip to content

Latest commit

 

History

History
62 lines (53 loc) · 2.51 KB

README.md

File metadata and controls

62 lines (53 loc) · 2.51 KB
Raw

Numerals & Commodity Visualization

Utilities and visualizations for CDLI accounting corpora. Included are an API for retrieving information about numerals and counted objects, and a web interface which allows for exploratory visualization of this data.

Framework Installation

By default, this project runs as part of the CDLI framework. See the next section for standalone installation instructions.

  1. Install the CDLI framework following these instructions. Ensure you have a recent copy of the database, as this project fetches data from the inscriptions and artifact_languages tables.
  2. Ensure that this project is enabled in framework/dev/config.json.dist:
"commodity-viz": {
  "is_default" : false,
  "enabled": true, /* set this to true */
  "scale" : 1
},
"commodity-api": {
  "is_default" : false,
  "enabled": true, /* set this to true */
  "scale" : 1
}
  1. Launch the framework using cdlidev.py. If this is the first time you are running the project, this should build two docker containers.
cd framework/dev
./cdlidev.py up

If the containers do not (re)build automatically, force them with

./cdlidev up --build
  1. Once the docker containers have launched, access the web interface at http://127.0.0.1:4001/cdli-accounting-viz/ or query the API directly at http://127.0.0.1:8087.

(Optional) 5. The commodity-api image already contains a static copy of all of the commodity data extracted from the CDLI's Sumerian corpora. To manually update this data, launch the container and run

python3 generate.py

Ensure that the framework's mariadb container is running at the same time, as this script requires database access.

Standalone Installation

  1. Build the docker containers:
docker-compose build
  1. Launch the containers, remapping some ports to match the behavior of the containers on the framework:
docker run --publish 8087:8088 --detach cdli-accounting-viz_viz-api
docker run --publish 4001:80 --detach cdli-accounting-viz_viz-site
  1. Access the visualization interface at http://127.0.0.1:4001/cdli-accounting-viz/ or access the API directly at 127.0.0.1:8087

User Guide

Available here.

API Documentation

When the application is running, access the documentation at http://127.0.0.1:8087/docs/