Skip to content

Commit 2eea387

Browse files
docs: archive repo and redirect to docs.datajoint.com
This repository is being archived as all tutorials have moved to the unified documentation at docs.datajoint.com/tutorials/. Changes: - Prominent archive notice at top - Clear redirect to new tutorial location - Table mapping old content to new locations - Links to all tutorial categories - Migration guide link for legacy users - Contributing instructions for new docs repo - Support links All content has been migrated and updated for DataJoint 2.0.
1 parent 56b0748 commit 2eea387

File tree

1 file changed

+49
-82
lines changed

1 file changed

+49
-82
lines changed

README.md

Lines changed: 49 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -1,103 +1,70 @@
1-
# Welcome to DataJoint tutorials!
1+
# ⚠️ Repository Archived
22

3-
DataJoint is an open-source library for scientific research labs to design and build
4-
data pipelines for automated data analysis and sharing.
3+
> **This repository has been archived and is no longer maintained.**
4+
>
5+
> **All tutorials have moved to the unified DataJoint documentation:**
6+
>
7+
> 🔗 **https://docs.datajoint.com/tutorials/**
58
6-
This document will guide you through interactive tutorials written in
7-
[Python](https://www.python.org/) and organized in [Jupyter
8-
notebooks](https://jupyter-notebook.readthedocs.io/en/stable/).
9+
---
910

10-
*Please note that these hands-on DataJoint tutorials are friendly to non-expert users, and advanced programming skills are not required.*
11+
## Where to Find Content
1112

13+
All content from this repository has been migrated and updated for DataJoint 2.0+:
1214

13-
## Table of contents
14-
- The [tutorials](./tutorials) folder contains interactive Jupyter notebooks designed to teach DataJoint. The calcium imaging and electrophysiology tutorials provide examples of defining and interacting with data pipelines. In addition, some fill-in-the-blank sections are included for you to code yourself!
15-
- 01-DataJoint Basics
16-
- 02-Calcium Imaging Imported Tables
17-
- 03-Calcium Imaging Computed Tables
18-
- 04-Electrophysiology Imported Tables
19-
- 05-Electrophysiology Computed Tables
15+
| Old Location | New Location |
16+
|--------------|--------------|
17+
| **All Tutorials** | [docs.datajoint.com/tutorials](https://docs.datajoint.com/tutorials/) |
18+
| DataJoint Basics | [First Pipeline Tutorial](https://docs.datajoint.com/tutorials/basics/01-first-pipeline/) |
19+
| Calcium Imaging | [Calcium Imaging Tutorial](https://docs.datajoint.com/tutorials/domain/calcium-imaging/calcium-imaging/) |
20+
| Electrophysiology | [Electrophysiology Tutorial](https://docs.datajoint.com/tutorials/domain/electrophysiology/electrophysiology/) |
21+
| Quick Start (30min) | [Tutorials Index](https://docs.datajoint.com/tutorials/) |
2022

21-
- The [completed_tutorials](./completed_tutorials) folder contains Jupyter notebooks with all code sections completed and solved.
23+
## New Documentation Structure
2224

23-
- You will find the following notebooks in the [short_tutorials](./short_tutorials) folder:
24-
- DataJoint in 30min
25-
- University
25+
The DataJoint documentation now follows the [Diátaxis](https://diataxis.fr/) framework:
2626

27+
- **[Tutorials](https://docs.datajoint.com/tutorials/)** — Learn by building (replaces this repo)
28+
- **[How-To Guides](https://docs.datajoint.com/how-to/)** — Task-oriented guides
29+
- **[Explanation](https://docs.datajoint.com/explanation/)** — Concepts and design
30+
- **[Reference](https://docs.datajoint.com/reference/)** — API and specifications
2731

28-
## Key learnings from the tutorials
32+
## Interactive Environment
2933

30-
After completing this set of tutorials, you will gain real experience in the basics of the DataJoint framework. These skills will allow you to design, implement and manage data pipelines effectively applied to your scientific research.
34+
The new tutorials include:
3135

32-
Here is a summary of the content that you can expect to have learned:
36+
**Updated for DataJoint 2.0** — All code examples use the latest syntax
37+
**GitHub Codespaces ready** — Same easy cloud-based environment
38+
**Jupyter notebooks** — Same interactive format
39+
**Expanded content** — More examples and domain-specific tutorials
3340

34-
- Understanding DataJoint basics: concepts, design, and structure (~1 hour)
35-
- Create schemas/tables
36-
- Table tiers (`Lookup`, `Manual`, `Imported`, `Computed`)
37-
- Insert entries and view entries in tables
38-
- Table dependency and data integrity
39-
- Basic operations
40-
- Restriction - `&`
41-
- Join - `*`
42-
- Projection - `.proj()`
43-
- Fetch - `.fetch()`
44-
- Deletion - `.delete()`
45-
- Drop - `.drop()`
41+
## Getting Started
4642

47-
- DataJoint advanced topics: pipeline automation (~1 hour)
48-
- `Imported` and `Computed` tables
49-
- `make()` function
50-
- `.populate()` for automated computation
51-
- `.populate(reserve_jobs=True)` for parallelization
52-
43+
1. Visit **[docs.datajoint.com/tutorials](https://docs.datajoint.com/tutorials/)**
44+
2. Follow the [Quick Start](https://docs.datajoint.com/tutorials/) guide
45+
3. Try tutorials in [GitHub Codespaces](https://github.com/datajoint/datajoint-docs#interactive-environment)
5346

54-
## Interactive Environment
47+
## Migration to DataJoint 2.0
5548

56-
- These interactive DataJoint tutorials can be accessed through a cloud-based environment on [GitHub Codespaces](https://github.com/features/codespaces). The following instructions will provide you with an environment that is configured with DataJoint for Python so that you can immediately begin to build and run a data pipeline.
57-
- Instructions
58-
- Sign up for a free a [GitHub](https://github.com/) account.
59-
- Fork this repository.
60-
- Launch the environment using GitHub Codespaces on your fork with the default options by selecting the green `Code` button, then the `Codespaces` tab, and then the green `Create codespace on main` button. For more control, under the `Codespaces` tab select the `...` button where you may create `New with options....`.
61-
- The launch time for the Codespace is less that 2 minutes.
62-
- You will know your environment has finished loading once the `pip install -e .` command has run and the terminal prompt is clear.
63-
- To begin, navigate to the `tutorials` directory located in the left panel and proceed through the sequentially organized Jupyter notebooks. Execute the cells in the notebooks to begin your walkthrough of the tutorial.
64-
- Once you are done, see the options in the menu in the bottom-left corner. In Codespaces, you can `Stop Current Codespace`. By default, GitHub will also automatically stop the Codespaces after 30 minutes of inactivity.
65-
- *Tip*: Each month, GitHub renews a [free-tier](https://docs.github.com/en/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#monthly-included-storage-and-core-hours-for-personal-accounts) quota of computing and storage. Typically we run into the storage limits before anything else since Codespaces consume storage while stopped. It is best to delete [Codespaces](https://github.com/codespaces) when not actively in use and recreate them when needed. Once any portion of your quota is reached, you will need to wait for it to be reset at the end of your cycle or add billing info to your GitHub account to handle overages.
66-
- *Tip*: GitHub auto names the Codespaces, but you can rename the Codespace so that it is easier to identify later.
67-
- *Tip*: All the edits you make in these tutorial notebooks are ***not persistent***. Edits will be reset to the original content every time you restart the server. However, you can easily commit the changes to your fork.
49+
If you're using DataJoint 0.14.x or earlier:
6850

51+
📖 See the [Migration Guide](https://docs.datajoint.com/how-to/migrate-to-v20/)
6952

70-
## Documentation
53+
## Contributing
7154

72-
- For more information on DataJoint Python, please refer to the [documentation](https://datajoint.com/docs/core/datajoint-python/).
55+
Contributions now go through the unified documentation repository:
7356

57+
- **Documentation:** [github.com/datajoint/datajoint-docs](https://github.com/datajoint/datajoint-docs)
58+
- **Contributing Guide:** [docs.datajoint.com/about/contributing](https://docs.datajoint.com/about/contributing/)
7459

7560
## Support
76-
If you need help getting started or run into any errors, please open a GitHub Issue or contact our team by email at support@datajoint.com.
77-
78-
79-
## Additional DataJoint Tutorials
80-
81-
- DataJoint Elements is a collection of curated modules for assembling data pipelines for several modalities of neurophysiology experiments.
82-
- [Element Calcium Imaging Tutorial](https://github.com/datajoint/element-calcium-imaging#interactive-tutorial)
83-
- [Element Array Electrophysiology Tutorial](https://github.com/datajoint/workflow-array-ephys#interactive-tutorial)
84-
85-
- [Machine Intelligence from Cortical Networks (MICrONS) program](https://www.microns-explorer.org/)
86-
- [MICrONS Tutorial](https://github.com/datajoint/microns_phase3_nda#interactive-environment)
87-
88-
89-
## Developer Instructions
90-
- Local environment instructions
91-
- Install the following:
92-
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
93-
- [Docker](https://docs.docker.com/get-docker/)
94-
- On M1/M2 Mac:
95-
- Enable Rosetta 2 on Docker advanced/experimental settings
96-
- Ensure Rosetta is installed by typing `softwareupdate --install-rosetta` at a shell prompt
97-
- `export DOCKER_DEFAULT_PLATFORM=linux/amd64` in .zshrc or at a shell prompt
98-
- [Microsoft's Visual Studio Code (VS Code)](https://code.visualstudio.com/)
99-
- VSCode [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers).
100-
- `git clone` your fork of the repository and open it in VSCode.
101-
- Use the `Dev Containers extension` to `Reopen in Container`. (More info in the `Getting started` included with the extension.)
102-
- To begin, navigate to the [tutorials](./tutorials) directory located in the left panel and proceed through the sequentially organized Jupyter notebooks. Execute the cells in the notebooks to begin your walkthrough of the tutorial.
103-
- Once you are done, you can stop the container by closing the `VS Code` window.
61+
62+
- **Documentation:** https://docs.datajoint.com
63+
- **Community:** [GitHub Discussions](https://github.com/datajoint/datajoint-python/discussions)
64+
- **Issues:** [datajoint-docs issues](https://github.com/datajoint/datajoint-docs/issues)
65+
- **Email:** support@datajoint.com
66+
67+
---
68+
69+
**Last Updated:** January 2026
70+
**Archive Date:** January 2026

0 commit comments

Comments
 (0)