Skip to content

Commit cc529a7

Browse files
committed
Move Developer Instructions to the end of README
1 parent 5f1e9a7 commit cc529a7

File tree

1 file changed

+22
-16
lines changed

1 file changed

+22
-16
lines changed

README.md

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ This document will guide you as a new DataJoint user through interactive tutoria
66

77
*Please note that these hands-on DataJoint tutorials are friendly to non-expert users, and advanced programming skills are not required.*
88

9+
910
## Table of contents
1011
- In the [tutorials](./tutorials) folder are interactive Jupyter notebooks to learn 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!
1112
- 01-DataJoint Basics
@@ -20,6 +21,7 @@ This document will guide you as a new DataJoint user through interactive tutoria
2021
- DataJoint in 30min
2122
- University
2223

24+
2325
## Key learnings from the tutorials
2426

2527
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.
@@ -45,6 +47,7 @@ Here is a summary of the content that you can expect to have learned:
4547
- `.populate()` for automated computation
4648
- `.populate(reserve_jobs=True)` for parallelization
4749

50+
4851
## Interactive Environment
4952

5053
- 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.
@@ -60,21 +63,6 @@ Here is a summary of the content that you can expect to have learned:
6063
- *Tip*: GitHub auto names the Codespaces, but you can rename the Codespace so that it is easier to identify later.
6164
- *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.
6265

63-
## Developer Instructions
64-
- **Local environment**:
65-
- Install the following:
66-
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
67-
- [Docker](https://docs.docker.com/get-docker/)
68-
- On M1/M2 Mac:
69-
- Enable Rosetta 2 on Docker advanced/experimental settings
70-
- Ensure Rosetta is installed by typing `softwareupdate --install-rosetta` at a shell prompt
71-
- `export DOCKER_DEFAULT_PLATFORM=linux/amd64` in .zshrc or at a shell prompt
72-
- [Microsoft's Visual Studio Code (VS Code)](https://code.visualstudio.com/)
73-
- VSCode [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers).
74-
- `git clone` your fork of the repository and open it in VSCode.
75-
- Use the `Dev Containers extension` to `Reopen in Container`. (More info in the `Getting started` included with the extension.)
76-
- 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.
77-
- Once you are done, you can stop the container by closing the `VS Code` window.
7866

7967
## Documentation
8068

@@ -84,11 +72,29 @@ Here is a summary of the content that you can expect to have learned:
8472
## Support
8573
If you need help getting started or run into any errors, please open a GitHub Issue or contact our team by email at [email protected].
8674

75+
8776
## Additional DataJoint Tutorials
8877

8978
- DataJoint Elements is a collection of curated modules for assembling data pipelines for several modalities of neurophysiology experiments.
9079
- [Element Calcium Imaging Tutorial](https://github.com/datajoint/element-calcium-imaging#interactive-tutorial)
9180
- [Element Array Electrophysiology Tutorial](https://github.com/datajoint/workflow-array-ephys#interactive-tutorial)
9281

9382
- [Machine Intelligence from Cortical Networks (MICrONS) program](https://www.microns-explorer.org/)
94-
- [MICrONS Tutorial](https://github.com/datajoint/microns_phase3_nda#interactive-environment)
83+
- [MICrONS Tutorial](https://github.com/datajoint/microns_phase3_nda#interactive-environment)
84+
85+
86+
## Developer Instructions
87+
- **Local environment**:
88+
- Install the following:
89+
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
90+
- [Docker](https://docs.docker.com/get-docker/)
91+
- On M1/M2 Mac:
92+
- Enable Rosetta 2 on Docker advanced/experimental settings
93+
- Ensure Rosetta is installed by typing `softwareupdate --install-rosetta` at a shell prompt
94+
- `export DOCKER_DEFAULT_PLATFORM=linux/amd64` in .zshrc or at a shell prompt
95+
- [Microsoft's Visual Studio Code (VS Code)](https://code.visualstudio.com/)
96+
- VSCode [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers).
97+
- `git clone` your fork of the repository and open it in VSCode.
98+
- Use the `Dev Containers extension` to `Reopen in Container`. (More info in the `Getting started` included with the extension.)
99+
- 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.
100+
- Once you are done, you can stop the container by closing the `VS Code` window.

0 commit comments

Comments
 (0)