Skip to content

Commit 1d22a67

Browse files
docs: add version verification to installation guide
Critical update for pre-release period: - Added warning admonition about 2.0+ requirement - Clarified PyPI/conda releases are in preparation - Enhanced 'Verify Installation' section with expected output - Added danger admonition for version mismatch with clear options - Updated development installation to specify pre/v2.0 branch - Provided three clear paths for users with wrong version This prevents confusion when users install 0.14.x from PyPI/conda and try to follow 2.0 documentation.
1 parent e64cc7d commit 1d22a67

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

src/how-to/installation.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
Install DataJoint Python and set up your environment.
44

5+
!!! warning "DataJoint 2.0+ Required"
6+
7+
This documentation is for **DataJoint 2.0 and later**. The PyPI and conda releases for DataJoint 2.0 are currently in preparation.
8+
9+
**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.
10+
511
## Basic Installation
612

713
```bash
@@ -23,19 +29,35 @@ pip install datajoint[all]
2329

2430
## Development Installation
2531

32+
To install the latest pre-release version:
33+
2634
```bash
27-
git clone https://github.com/datajoint/datajoint-python.git
35+
git clone -b pre/v2.0 https://github.com/datajoint/datajoint-python.git
2836
cd datajoint-python
2937
pip install -e ".[dev]"
3038
```
3139

3240
## Verify Installation
3341

42+
**Important:** Check that you have DataJoint 2.0 or later:
43+
3444
```python
3545
import datajoint as dj
3646
print(dj.__version__)
3747
```
3848

49+
**Expected output:** `2.0.0` or higher
50+
51+
!!! danger "Version Mismatch"
52+
53+
If you see version `0.14.x` or lower, you have the legacy version of DataJoint. This documentation will not match your installed version.
54+
55+
**Options:**
56+
57+
1. **Upgrade to 2.0 (pre-release):** Install from the `pre/v2.0` branch (see Development Installation above)
58+
2. **Use legacy documentation:** Visit [datajoint.github.io/datajoint-python](https://datajoint.github.io/datajoint-python)
59+
3. **Migrate existing pipeline:** Follow the [Migration Guide](migrate-to-v20.md)
60+
3961
## Database Server
4062

4163
DataJoint requires a MySQL-compatible database server:

0 commit comments

Comments
 (0)