Skip to content

Commit f25540f

Browse files
docs: Update for DataJoint 2.0 stable release (#147)
- Remove pre-release warnings and notices - Update installation instructions for pip install - Update version references from 2.0.0a22 to 2.0.0 - Remove pre/v2.0 branch references - Add [viz] optional dependency documentation Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 003f0d5 commit f25540f

File tree

4 files changed

+23
-39
lines changed

4 files changed

+23
-39
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ This repository contains the source for the DataJoint documentation, organized u
2828
git clone https://github.com/datajoint/datajoint-docs.git
2929
cd datajoint-docs
3030
cd ..
31-
git clone -b pre/v2.0 https://github.com/datajoint/datajoint-python.git
31+
git clone https://github.com/datajoint/datajoint-python.git
3232
cd datajoint-docs
3333

3434
# Start live preview at http://localhost:8000

src/how-to/installation.md

Lines changed: 15 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2,43 +2,31 @@
22

33
Install DataJoint Python and set up your environment.
44

5-
!!! warning "Pre-Release Documentation"
6-
7-
This documentation covers **DataJoint 2.0**, which is currently in pre-release.
8-
9-
- **For production use:** Install the stable version (0.14.x) and use [legacy docs](https://datajoint.github.io/datajoint-python)
10-
- **For testing 2.0:** Follow the pre-release installation instructions below
11-
- **For migration:** See the [Migration Guide](migrate-to-v20.md)
12-
13-
## Choose Your Installation
14-
15-
### Pre-Release (2.0) — For Testing and Development
16-
17-
**Note:** DataJoint 2.0 is not yet on PyPI/conda. Install from the pre-release branch:
5+
## Install DataJoint 2.0
186

197
```bash
20-
git clone -b pre/v2.0 https://github.com/datajoint/datajoint-python.git
21-
cd datajoint-python
22-
pip install -e ".[dev]"
8+
pip install datajoint
239
```
2410

2511
**With optional dependencies:**
2612

2713
```bash
14+
# For diagram visualization (matplotlib, ipython)
15+
pip install datajoint[viz]
16+
2817
# For polars DataFrame support
29-
pip install -e ".[polars]"
18+
pip install datajoint[polars]
3019

31-
# For all optional dependencies
32-
pip install -e ".[all]"
20+
# For cloud storage backends
21+
pip install datajoint[s3] # AWS S3
22+
pip install datajoint[gcs] # Google Cloud Storage
23+
pip install datajoint[azure] # Azure Blob Storage
3324
```
3425

35-
### Stable (0.14.x) — For Production Use
36-
37-
```bash
38-
pip install datajoint
39-
```
26+
!!! note "Upgrading from 0.14.x?"
4027

41-
**Note:** This installs DataJoint 0.14.x. The tutorials and guides in this documentation are written for 2.0 and will not match the stable API. Use [legacy documentation](https://datajoint.github.io/datajoint-python) instead.
28+
See the [Migration Guide](migrate-to-v20.md) for breaking changes and upgrade instructions.
29+
Legacy documentation for 0.14.x is available at [datajoint.github.io](https://datajoint.github.io/datajoint-python).
4230

4331
## Verify Installation
4432

@@ -53,12 +41,11 @@ print(dj.__version__)
5341
- `2.0.0` or higher — You're ready to follow this documentation
5442
- `0.14.x` or lower — You have the stable version, use [legacy docs](https://datajoint.github.io/datajoint-python) instead
5543

56-
### If You Have the Wrong Version
44+
### If You Have an Older Version
5745

5846
| Your Situation | Action |
5947
|----------------|--------|
60-
| Installed 0.14.x but want to test 2.0 | Follow pre-release installation above |
61-
| Installed 2.0 but need production stability | `pip uninstall datajoint && pip install datajoint` |
48+
| Installed 0.14.x, want to upgrade | `pip install --upgrade datajoint` |
6249
| Have existing 0.14.x pipeline to upgrade | Follow [Migration Guide](migrate-to-v20.md) |
6350

6451
## Database Server

src/how-to/use-plugin-codecs.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ Check compatibility with your DataJoint version:
237237

238238
```bash
239239
pip show dj-zarr-codecs
240-
# Requires: datajoint>=2.0.0a22
240+
# Requires: datajoint>=2.0.0
241241
```
242242

243243
Upgrade DataJoint if needed:
@@ -552,14 +552,14 @@ Add plugin codecs to your project dependencies:
552552

553553
**requirements.txt:**
554554
```
555-
datajoint>=2.0.0a22
555+
datajoint>=2.0.0
556556
dj-zarr-codecs>=0.1.0
557557
```
558558

559559
**pyproject.toml:**
560560
```toml
561561
dependencies = [
562-
"datajoint>=2.0.0a22",
562+
"datajoint>=2.0.0",
563563
"dj-zarr-codecs>=0.1.0",
564564
]
565565
```
@@ -574,7 +574,7 @@ My Pipeline
574574
===========
575575
576576
Requirements:
577-
- datajoint>=2.0.0a22
577+
- datajoint>=2.0.0
578578
- dj-zarr-codecs>=0.1.0 # For waveform storage
579579
580580
Install:

src/index.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
11
# DataJoint Documentation
22

3-
!!! info "Documentation for DataJoint 2.x (Pre-Release)"
3+
!!! tip "Upgrading from 0.14.x?"
44

5-
This documentation covers **DataJoint 2.0–2.1**, currently in pre-release.
6-
7-
- **Using stable 0.14.x?** Visit [legacy docs](https://datajoint.github.io/datajoint-python)
8-
- **Want to test 2.x?** See [Installation Guide](how-to/installation.md)
9-
- **Migrating a pipeline?** Follow the [Migration Guide](how-to/migrate-to-v20.md)
5+
- **Migration guide:** [Migrate to 2.0](how-to/migrate-to-v20.md)
6+
- **Legacy docs:** [datajoint.github.io](https://datajoint.github.io/datajoint-python)
107

118
## About DataJoint
129

0 commit comments

Comments
 (0)