Skip to content

Commit 5f1e9a7

Browse files
Update README.md
Co-authored-by: Kabilar Gunalan <[email protected]>
1 parent 8d3ecb2 commit 5f1e9a7

File tree

1 file changed

+14
-20
lines changed

1 file changed

+14
-20
lines changed

README.md

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -45,26 +45,20 @@ Here is a summary of the content that you can expect to have learned:
4545
- `.populate()` for automated computation
4646
- `.populate(reserve_jobs=True)` for parallelization
4747

48-
49-
## Quick start
50-
51-
### User installation
52-
DataJoint tutorials are easily accessible using an **interactive environment** that contains all the software required to run the experiments. The setting is configured by [DevContainer] (https://containers.dev/). Here are two options to launch the interactive environment.
53-
54-
*Please note that to use the DataJoint Python package with an interactive environment, you need a [GitHub](https://github.com/) account.*
55-
56-
- **Cloud-based environment: GitHub Codespaces**: (*recommended*)
57-
- This is the easiest option for **tutorial users**. You will immediately start coding using DataJoint and Python, without installing software or local environments. Cloud-based environments (IDEs), such as [GitHub Codespaces](https://github.com/features/codespaces), use built-in tools directly connected to the cloud and work on the browser.
58-
59-
- Instructions:
60-
- Fork the [datajoint-tutorials](https://github.com/datajoint/datajoint-tutorials) repository into your repository.
61-
- From your `datajoint-tutorials` repository, click on `Code`, then click on `Codespaces` tab, and `+` option will `Create codespace on main` on your fork with default options. For more control, see the `...` where you may create `New with options...`.
62-
- The building time for Codespaces is **~5m**. This is done infrequently and cached for convenience.
63-
- The start time for Codespaces is **~30s**. This will pull the built codespace from the cache when you need it.
64-
- *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.
65-
- *Tip*: GitHub auto names the Codespaces, but you can rename the Codespaces so that it is easier to identify later.
66-
- 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.
67-
- 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.
48+
## Interactive Environment
49+
50+
- 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.
51+
- Instructions
52+
- Sign up for a free a [GitHub](https://github.com/) account.
53+
- Fork this repository.
54+
- 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....`.
55+
- The launch time for the Codespace is less that 2 minutes.
56+
- You will know your environment has finished loading once the `pip install -e .` command has run and the terminal prompt is clear.
57+
- 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.
58+
- 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.
59+
- *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.
60+
- *Tip*: GitHub auto names the Codespaces, but you can rename the Codespace so that it is easier to identify later.
61+
- *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.
6862

6963
## Developer Instructions
7064
- **Local environment**:

0 commit comments

Comments
 (0)