add tpc-ds and other edits (#6)

* qs

* edits

* wip

* updates

.github/workflows/cicd.yaml

@@ -0,0 +1,47 @@
+name: cicd
+
+permissions:
+  contents: write
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    paths:
+      - 'justfile'
+      - 'website/**'
+      - 'dev-requirements.txt'
+      - '.github/workflows/cicd.yaml'
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: true
+          fetch-depth: 0
+
+      - uses: extractions/setup-just@v1
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.12
+
+      - uses: quarto-dev/quarto-actions/setup@v2
+
+      - name: install requirements
+        run: just setup
+
+      - name: build site
+        run: |
+          . .venv/bin/activate
+          just docs-build
+
+      - name: deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: github.ref == 'refs/heads/main'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: website/_output

.gitignore

@@ -1,11 +1,16 @@
-dist
-venv
 .tmp
 .env
+.venv
+dist
 __pycache__
 *.parquet
 results_data
 tpch_data
+tpcds_data
 bench*log*
 ibis_bench.log
 out.log
+
+_output
+
+2024-08-23

README.md

@@ -1,3 +1,43 @@
 # ibis-bench
 
-work in progress
+***Benchmarking with Ibis.***
+
+## Overview
+
+Ibis is an ***interface***, not an ***engine***. There's no such thing as a zero-cost abstraction with no overhead, but Ibis is designed to add as little as possible to your workloads. This repository is used to:
+
+- benchmark various engines via the same interface
+- roughly assess the overhead of using Ibis (by comparing with native queries)
+
+with a focus on the former and, currently, single-node OLAP engines.
+
+## Getting started
+
+Install the package and CLI.
+
+### Developer setup
+
+Install [`gh`](https://github.com/cli/cli) and [`just`](https://github.com/casey/just), then:
+
+```
+gh repo clone lostmygithubaccount/ibis-bench
+cd ibis-bench
+just setup
+. .venv/bin/activate
+```
+
+### Pip install
+
+Run:
+
+```bash
+pip install --upgrade ibis-bench
+```
+
+## Usage
+
+Use the CLI to run benchmarks.
+
+```bash
+bench
+```