Skip to content

Commit c16e79f

Browse files
docs: Update README with Relational Workflow Model and OAS
- Align introduction with documentation home page - Explain Relational Workflow Model core concepts - Add Object-Augmented Schemas (OAS) section - Announce DataJoint 2.0 with migration guide reference 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
1 parent 5a9bc4a commit c16e79f

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
11
# DataJoint for Python
22

3-
DataJoint is an open-source Python framework for building scientific data pipelines.
4-
It implements the **Relational Workflow Model**—a paradigm that extends relational
5-
databases with native support for computational workflows.
3+
DataJoint is a framework for scientific data pipelines that introduces the **Relational Workflow Model**—a paradigm where your database schema is an executable specification of your workflow.
64

7-
**Key Features:**
5+
Traditional databases store data but don't understand how it was computed. DataJoint extends relational databases with native workflow semantics:
86

9-
- **Declarative schema design** — Define tables and relationships in Python
10-
- **Automatic dependency tracking** — Foreign keys encode workflow dependencies
11-
- **Built-in computation** — Imported and Computed tables run automatically
12-
- **Data integrity** — Referential integrity and transaction support
13-
- **Reproducibility** — Immutable data with full provenance
7+
- **Tables represent workflow steps** — Each table is a step in your pipeline where entities are created
8+
- **Foreign keys encode dependencies** — Parent tables must be populated before child tables
9+
- **Computations are declarative** — Define *what* to compute; DataJoint determines *when* and tracks *what's done*
10+
- **Results are immutable** — Computed results preserve full provenance and reproducibility
11+
12+
### Object-Augmented Schemas
13+
14+
Scientific data includes both structured metadata and large data objects (time series, images, movies, neural recordings, gene sequences). DataJoint solves this with **Object-Augmented Schemas (OAS)**—a unified architecture where relational tables and object storage are managed as one system with identical guarantees for integrity, transactions, and lifecycle.
15+
16+
### DataJoint 2.0
17+
18+
**DataJoint 2.0** solidifies these core concepts with a modernized API, improved type system, and enhanced object storage integration. Existing users can refer to the [Migration Guide](https://docs.datajoint.com/migration/) for upgrading from earlier versions.
1419

1520
**Documentation:** https://docs.datajoint.com
1621

0 commit comments

Comments
 (0)