DeepwellCup

Package for preparing figures, tables, and analyses for the annual Deepwell Cup.

Installation

Use the pip package manager for installation.

pip install git+https://github.com/ddeepwell/DeepwellCup.git

In a development environment, install the pre-commit hooks by executing pre-commit install.

The executable, pdflatex, is used to generate PDF documents of tables. On MacOS, it can be installed with brew install mactex.

Initialization

Before executing any commands, a products directory must be configured for figures and tables.

initialize

This directory is queried via

products_directory

Commands

Remake

Tables and figures for previous years are remade via

remake

It is configurable to remake a range of years and to place the data in a specific database.

Update

New selections and results are added to the database via

update_selections

and

update_results

respectively.