Vastlands Exploration

data exploration for tome of vastlands

Requirements:

• Python 3 installed (including the venv package)

Getting started (Unix): Run getting-started.sh

To edit the configuration values for the database, edit infrastructure/.env and apply the changes (e.g. export $(cat infrastructure/.env))

There are 3 main commands (each called by python3 main.py <command>:

• load: load all necessary data into the database
• plot: render and show the plots locally
• serve: start the server for hosting the interactive User Interface

For each, you can specify the following global arguments like this: python3 main.py <global options> <command>

• -u: URL to fetch the faergria map data from (defaults to http://localhost:1338). This requires that you start the server for the map API (https://github.com/Zetsuboushii/faergriaMap) locally.
• -s: Skip loading and showing faergria map data (use when faergria map server is not available)
• -f: Force refresh data (bypass database cache))

For the load command, you can additonally specify arguments like so: python3 main.py <global options> load <arguments>

• -e: Export all plots rendered via the plot command in the ./data/plots
• -h: When rendering plots, don't show the matplotlib window (but export anyway)
• --format: Image format for exported plots (e.g. png or svg)

Example: python3 main.py -s -f plot -e --format jpg

You can also see this information when running python3 main.py --help