Skip to content

Commit 1f9fe6f

Browse files
committed
README:instructions moved to cloud & local env
1 parent fc3d040 commit 1f9fe6f

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -66,23 +66,22 @@ DataJoint tutorials are easily accessible using an **interactive environment** t
6666
- The start time for Codespaces is **~30s**. This will pull the built codespace from the cache when you need it.
6767
- *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 when not actively in use and recreate them when needed. We'll soon be creating prebuilds to avoid larger build times. 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.
6868
- *Tip*: GitHub auto names the Codespaces, but you can rename the Codespaces so that it is easier to identify later.
69+
- To begin, navigate to the notebooks directory located in the left panel and proceed through the sequentially organized Jupyter notebooks, labeled by numbers. Execute the cells in the notebooks to begin your walkthrough of the tutorial.
70+
- 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.
6971

7072
- **Local environment**:
7173
- We highly recommend this option for users that who want to apply DataJoint to **their own neuroscience experiments** and lab research after exploring the tutorials. Additionally, this option is particularly advantageous for those who have a keen interest in **other modules of the DataJoint Elements Library** (e.g., Miniscope, DeepLabCut). For this option, ensure you have the following:
7274
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
7375
- [Docker](https://docs.docker.com/get-docker/)
7476
- [Microsoft's Visual Studio Code (VS Code)](https://code.visualstudio.com/)
7577
- [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers).
76-
78+
- To begin, navigate to the notebooks directory located in the left panel and proceed through the sequentially organized Jupyter notebooks, labeled by numbers. Execute the cells in the notebooks to begin your walkthrough of the tutorial.
79+
- Once you are done, see the options in the menu in the bottom-left corner. When running DevContainer on your machine, you can `Reopen folder locally`. By default, GitHub will also automatically stop the Codespaces after 30 minutes of inactivity.
80+
7781
For more detailed instructions, please check out the [User Guide in DataJoint Documentation](https://datajoint.com/docs/elements/user-guide/).
7882

7983
Before we start, remember that all the edits you make in these tutorial notebooks are ***not persistent*** - they will be reset to the original content every time you restart the server. However, you can easily download the notebooks that interest you in keeping the changes.
8084

81-
### Instructions
82-
- To begin, navigate to the notebooks directory located in the left panel and proceed through the sequentially organized Jupyter notebooks, labeled by numbers. Execute the cells in the notebooks to begin your walkthrough of the tutorial.
83-
84-
- Once you are done, see the options in the menu in the bottom-left corner. For example, in Codespaces you can `Stop Current Codespace`, but when running DevContainer on your machine the equivalent option is `Reopen folder locally`. By default, GitHub will also automatically stop the Codespaces after 30 minutes of inactivity.
85-
8685
## Support
8786
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].
8887

0 commit comments

Comments
 (0)