|
1 | 1 | # DataJoint interactive tutorial using GitHub Codespaces |
2 | 2 |
|
3 | | -### This README is the guide to setting up an interactive tutorial on DataJoint basics using GitHub Codespaces. Please follow the steps below for the best experience: |
| 3 | +Interactive tutorials on the DataJoint framework, in python. Throughout this set of tutorials, you will learn |
| 4 | + |
| 5 | +- DataJoint basics |
| 6 | + - Create schemas/tables |
| 7 | + - Table tiers (`Lookup`, `Manual`, `Imported`, `Computed`) |
| 8 | + - Insert entries and view entries in tables |
| 9 | + - Table dependency and data integrity |
| 10 | + - Query operations |
| 11 | + - Restriction - `&` |
| 12 | + - Join - `*` |
| 13 | + - Projection - `.proj()` |
| 14 | + - Aggregation - `.aggr()` |
| 15 | + - Fetch operations |
| 16 | + - Retrieve everything |
| 17 | + - Retrieve primary key - `.fetch("KEY")` |
| 18 | + - Retrieve selective attributes |
| 19 | + - Delete operations |
| 20 | +- DataJoint Advanced |
| 21 | + - `Imported` and `Computed` tables |
| 22 | + - `make()` function |
| 23 | + - `.populate()` for automated computation |
| 24 | + - `.populate(reserve_jobs=True)` for parallelization |
| 25 | + |
| 26 | + |
| 27 | +## Getting started |
| 28 | + |
| 29 | +The easiest way to start this interactive tutorial on DataJoint basics is to use [GitHub Codespace](https://docs.github.com/en/codespaces/overview). Please follow the steps below for the best experience: |
4 | 30 |
|
5 | 31 | 1. Fork this repository to your own GitHub account. |
6 | 32 |
|
|
10 | 36 |
|
11 | 37 | 4. If this is your first time using Codespaces with this repository, please click on the green `Create codespace on master` button. |
12 | 38 |
|
13 | | -5. Wait for the environment to be created. This step takes ~ 5 minutes. You will know the environment is ready when a Visual Studio Code window is rendered within your browser. If you are new to Visual Studio Code, please take a minute to familiarize yourself with the layout. The directories you will need to navigate are on the left side of the screen by default. |
| 39 | +5. Wait for the environment to be created. This step takes ~5 minutes the very first time being launched, and typically around ~1 minute if you revisit this codespace again in the future. |
14 | 40 |
|
15 | | -6. Navigate to the 00-Getting_started directory and open the `00-Getting started.ipynb` Jupyter Notebook. Execute the cells in this notebook to being your walk through the tutorials. |
| 41 | +6. You will know the environment is ready when a Visual Studio Code window is rendered within your browser. If you are new to Visual Studio Code, please take a minute to familiarize yourself with the layout. The directories you will need to navigate are on the left side of the screen by default. |
| 42 | + |
| 43 | +7. Navigate to the 00-Getting_started directory and open the `00-Getting started.ipynb` Jupyter Notebook. Execute the cells in this notebook to being your walk through the tutorials. |
16 | 44 |
|
17 | 45 | We recommend finishing all notebooks in `Getting_started` before proceeding to `Calcium_imaging` and `Electrophysiology`. Once you are done, GitHub will automatically terminate the Codespace after 30 minutes of inactivity or you can manually terminate the Codespace. |
18 | 46 |
|
|
0 commit comments