Skip to content

Commit 79190a8

Browse files
mprammerclaude
andauthored
Add CITATION.cff (#8112)
Adds a `CITATION.cff` so GitHub shows a "Cite this repository" button and exposes machine-readable citation metadata, plus a cite badge in the README that links to it. Structure and author list follow Spiral's Raincloud file; fields are retargeted to Vortex — version 0.72.0, the `vortex-data/vortex` remote, and an abstract that frames Vortex as an extensible framework for compressed columnar data with a default file format, rather than a single format. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Signed-off-by: mprammer <martin@spiraldb.com> Co-authored-by: Claude <noreply@anthropic.com>
1 parent 6ddc4d5 commit 79190a8

3 files changed

Lines changed: 41 additions & 1 deletion

File tree

CITATION.cff

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
cff-version: 1.2.0
2+
title: Vortex
3+
abstract: >-
4+
Vortex is an extensible framework for compressed columnar data, spanning
5+
in-memory arrays, on-disk file formats, over-the-wire protocols, and query
6+
engine integrations. It decouples a logical type system from physical layout
7+
and provides a pluggable system of cascading compression encodings that
8+
operate directly on compressed data with zero-copy Apache Arrow
9+
compatibility. These components compose into a default file format, and
10+
Vortex integrates with engines including DataFusion, DuckDB, and Spark.
11+
type: software
12+
version: 0.72.0
13+
date-released: 2026-05-20
14+
url: "https://github.com/vortex-data/vortex"
15+
repository-code: "https://github.com/vortex-data/vortex"
16+
license: Apache-2.0
17+
authors:
18+
- given-names: Nicholas
19+
family-names: Gates
20+
email: "nick@spiraldb.com"
21+
affiliation: Spiral
22+
- given-names: Robert
23+
family-names: Kruszewski
24+
email: "robert@spiraldb.com"
25+
affiliation: Spiral
26+
- given-names: Will
27+
family-names: Manning
28+
email: "will@spiraldb.com"
29+
affiliation: Spiral
30+
keywords:
31+
- columnar
32+
- file-format
33+
- compression
34+
- arrow
35+
- encodings
36+
- object-storage
37+
message: >-
38+
If you use Vortex in academic work, please cite it using the metadata in this
39+
file.

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
[![PyPI - Version](https://img.shields.io/pypi/v/vortex-data)](https://pypi.org/project/vortex-data/)
99
[![Maven - Version](https://img.shields.io/maven-central/v/dev.vortex/vortex-spark)](https://central.sonatype.com/artifact/dev.vortex/vortex-spark)
1010
[![codecov](https://codecov.io/github/vortex-data/vortex/graph/badge.svg)](https://codecov.io/github/vortex-data/vortex)
11+
[![Cite](https://img.shields.io/badge/cite-CITATION.cff-blue)](CITATION.cff)
1112

1213
[Join the community on Slack!](https://vortex.dev/slack) | [Documentation](https://docs.vortex.dev/) | [Performance Benchmarks](https://bench.vortex.dev)
1314

REUSE.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ SPDX-FileCopyrightText = "Copyright the Vortex contributors"
3636
SPDX-License-Identifier = "CC-BY-4.0"
3737

3838
[[annotations]]
39-
path = ["**/.gitignore", ".gitmodules", ".python-version", "**/*.lock", "**/*.lockfile", "**/*.toml", "**/*.json", ".idea/**", ".github/**", "codecov.yml", "java/gradle/wrapper/gradle-wrapper.properties", "**.duckdb*"]
39+
path = ["**/.gitignore", ".gitmodules", ".python-version", "**/*.lock", "**/*.lockfile", "**/*.toml", "**/*.json", "CITATION.cff", ".idea/**", ".github/**", "codecov.yml", "java/gradle/wrapper/gradle-wrapper.properties", "**.duckdb*"]
4040
precedence = "override"
4141
SPDX-FileCopyrightText = "Copyright the Vortex contributors"
4242
SPDX-License-Identifier = "Apache-2.0"

0 commit comments

Comments
 (0)