Skip to content

Clarify DataJoint 2.0 pre-release status in installation guide #111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
dimitri-yatsenko wants to merge 2 commits into from
Closed

Clarify DataJoint 2.0 pre-release status in installation guide #111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
088ab03
docs: regenerate LLM files with corrected migration guide links
dimitri-yatsenko Jan 14, 2026
782eafb
docs: clarify DataJoint 2.0 pre-release status in installation guide
dimitri-yatsenko Jan 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 30 additions & 27 deletions src/how-to/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,61 +2,64 @@

Install DataJoint Python and set up your environment.

!!! warning "DataJoint 2.0+ Required"
!!! warning "Pre-Release Documentation"

This documentation is for **DataJoint 2.0 and later**. The PyPI and conda releases for DataJoint 2.0 are currently in preparation.
This documentation covers **DataJoint 2.0**, which is currently in pre-release.

**If you install now, you may get an older version (0.14.x).** After installation, verify you have version 2.0 or later before following the tutorials and guides.
- **For production use:** Install the stable version (0.14.x) and use [legacy docs](https://datajoint.github.io/datajoint-python)
- **For testing 2.0:** Follow the pre-release installation instructions below
- **For migration:** See the [Migration Guide](migrate-to-v20.md)

## Basic Installation
## Choose Your Installation

### Pre-Release (2.0) — For Testing and Development

**Note:** DataJoint 2.0 is not yet on PyPI/conda. Install from the pre-release branch:

```bash
pip install datajoint
git clone -b pre/v2.0 https://github.com/datajoint/datajoint-python.git
cd datajoint-python
pip install -e ".[dev]"
```

## With Optional Dependencies
**With optional dependencies:**

```bash
# For polars DataFrame support
pip install datajoint[polars]

# For PyArrow support
pip install datajoint[arrow]
pip install -e ".[polars]"

# For all optional dependencies
pip install datajoint[all]
pip install -e ".[all]"
```

## Development Installation

To install the latest pre-release version:
### Stable (0.14.x) — For Production Use

```bash
git clone -b pre/v2.0 https://github.com/datajoint/datajoint-python.git
cd datajoint-python
pip install -e ".[dev]"
pip install datajoint
```

**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.

## Verify Installation

**Important:** Check that you have DataJoint 2.0 or later:
Check your installed version:

```python
import datajoint as dj
print(dj.__version__)
```

**Expected output:** `2.0.0` or higher

!!! danger "Version Mismatch"

If you see version `0.14.x` or lower, you have the legacy version of DataJoint. This documentation will not match your installed version.
**Expected output for this documentation:**
- `2.0.0` or higher — You're ready to follow this documentation
- `0.14.x` or lower — You have the stable version, use [legacy docs](https://datajoint.github.io/datajoint-python) instead

**Options:**
### If You Have the Wrong Version

1. **Upgrade to 2.0 (pre-release):** Install from the `pre/v2.0` branch (see Development Installation above)
2. **Use legacy documentation:** Visit [datajoint.github.io/datajoint-python](https://datajoint.github.io/datajoint-python)
3. **Migrate existing pipeline:** Follow the [Migration Guide](migrate-to-v20.md)
| Your Situation | Action |
|----------------|--------|
| Installed 0.14.x but want to test 2.0 | Follow pre-release installation above |
| Installed 2.0 but need production stability | `pip uninstall datajoint && pip install datajoint` |
| Have existing 0.14.x pipeline to upgrade | Follow [Migration Guide](migrate-to-v20.md) |

## Database Server

Expand Down
8 changes: 6 additions & 2 deletions src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# DataJoint Documentation

!!! info "Documentation for DataJoint 2.0+"
!!! info "Documentation for DataJoint 2.0 (Pre-Release)"

Python code examples in this documentation use DataJoint 2.0 syntax. If you're using DataJoint pre-2.0, see the [Migration Guide](how-to/migrate-to-v20.md) or visit [legacy docs](https://datajoint.github.io/datajoint-python).
This documentation covers **DataJoint 2.0**, currently in pre-release.

- **Using stable 0.14.x?** Visit [legacy docs](https://datajoint.github.io/datajoint-python)
- **Want to test 2.0?** See [Installation Guide](how-to/installation.md)
- **Migrating a pipeline?** Follow the [Migration Guide](how-to/migrate-to-v20.md)

## About DataJoint

Expand Down
Loading