Skip to content

Commit 09c4e57

Browse files
committed
improve docs
1 parent 194034e commit 09c4e57

File tree

6 files changed

+62
-3
lines changed

6 files changed

+62
-3
lines changed

README.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,32 @@
11
# DataJoint interactive tutorial using GitHub Codespaces
22

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:
430

531
1. Fork this repository to your own GitHub account.
632

@@ -10,9 +36,11 @@
1036

1137
4. If this is your first time using Codespaces with this repository, please click on the green `Create codespace on master` button.
1238

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

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

1745
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.
1846

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Metadata-Version: 2.1
2+
Name: datajoint-tutorial
3+
Version: 0.1.0
4+
Summary: DataJoint interactive tutorials
5+
Home-page: https://github.com/datajoint-company/playground_tutorial
6+
Author: DataJoint
7+
Author-email: [email protected]
8+
License: MIT
9+
Keywords: neuroscience datajoint
10+
Platform: UNKNOWN
11+
12+
"
13+
DataJoint interactive tutorials with examples from electrophysiology, calcium-imaging
14+
15+
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
README.md
2+
setup.py
3+
datajoint_tutorial.egg-info/PKG-INFO
4+
datajoint_tutorial.egg-info/SOURCES.txt
5+
datajoint_tutorial.egg-info/dependency_links.txt
6+
datajoint_tutorial.egg-info/requires.txt
7+
datajoint_tutorial.egg-info/top_level.txt
8+
tutorial_pipeline/__init__.py
9+
tutorial_pipeline/ephys_cell_activity.py
10+
tutorial_pipeline/imaging.py
11+
tutorial_pipeline/mouse_session.py
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
datajoint
2+
seaborn
3+
scikit-image
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
tutorial_pipeline

0 commit comments

Comments
 (0)