refactor: remove binder (complex) and move local note

This commit is contained in:
rzmk 2024-05-30 19:51:10 -04:00
parent 805384539c
commit 67587d6fa0
5 changed files with 17 additions and 21 deletions

View file

@ -35,8 +35,6 @@ repository:
url: https://github.com/dathere/100.dathere.com # Online location of your book url: https://github.com/dathere/100.dathere.com # Online location of your book
branch: main # Which branch of the repository should be used when creating links (optional) branch: main # Which branch of the repository should be used when creating links (optional)
launch_buttons: launch_buttons:
notebook_interface: jupyterlab
binderhub_url: https://mybinder.org
thebe: true thebe: true
sphinx: sphinx:
config: config:

View file

@ -5,26 +5,25 @@
At the end of each lesson there may be an exercise that you may complete either: At the end of each lesson there may be an exercise that you may complete either:
- Within the page (uses Thebe) [](#thebe) - Within the page (uses Thebe) [](#thebe)
- In a separate online Jupyter lab environment (uses Binder) [](#binder)
- Locally on your computer [](#local) - Locally on your computer [](#local)
You may choose which approach you'd prefer then [continue to the next page](getting-started.md). You may choose an approach you prefer then [continue to the next page](getting-started.md).
(exercises-setup:thebe)= (exercises-setup:thebe)=
### Thebe ### Thebe
In the header for a lesson click the rocket icon and then in the dropdown click `Live Code`. Thebe should begin launching as shown in a new box that appears with its launch status. Once the status is set to `ready` (may take a few seconds/minutes), then you should be able to edit and run the code cell within the page by pressing the `run` button or pressing `shift + enter` when your cursor is within a code cell. In the header for a lesson click the rocket icon and then in the dropdown click `Live Code`. Thebe should begin launching as shown in a new box that appears with its launch status. Once the status is set to `ready` **(this may take a few seconds/minutes)**, then you should be able to edit and run the code cell within the page by pressing the `run` button or pressing `shift + enter` when your cursor is within a code cell.
Here's a screen recording that shows how to do this for each lesson: Here's a screen recording that shows how to do this for each lesson:
![Thebe demo](media/thebe-demo.gif) ![Thebe demo](media/thebe-demo.gif)
(exercises-setup:binder)= <!-- (exercises-setup:binder)=
### Binder ### Binder
In the header for a lesson click the rocket icon and then in the dropdown click `Binder`. Binder should be launching and once ready (may take a few seconds/minutes) an online Jupyter lab environment is set up for you to work with. In the header for a lesson click the rocket icon and then in the dropdown click `Binder`. Binder should be launching and once ready (may take a few seconds/minutes) an online Jupyter lab environment is set up for you to work with. -->
(exercises-setup:local)= (exercises-setup:local)=
@ -87,6 +86,17 @@ Bash completions allow you to press the tab key at certain locations while typin
You can download the current bash completions file from qsv's source code at [`contrib/bashly/completions.bash`](https://github.com/jqnatividad/qsv/blob/master/contrib/bashly/completions.bash). Then you may run `source completions.bash` to enable the completions in your current terminal instance. You may also move `completions.bash` to your home directory (`~/completions.bash`) and also create a `.bashrc` file in your home directory (`~/.bashrc`) to include `source completions.bash` as a line within it for the completions script to run whenever you launch a bash terminal. You can download the current bash completions file from qsv's source code at [`contrib/bashly/completions.bash`](https://github.com/jqnatividad/qsv/blob/master/contrib/bashly/completions.bash). Then you may run `source completions.bash` to enable the completions in your current terminal instance. You may also move `completions.bash` to your home directory (`~/completions.bash`) and also create a `.bashrc` file in your home directory (`~/.bashrc`) to include `source completions.bash` as a line within it for the completions script to run whenever you launch a bash terminal.
:::{admonition} Reminder for exercises
:class: important
If you're running exercises locally then make sure you change your directory (`cd`) into the relevant directory in the `lessons` folder for each exercise. For example for the first exercise you may run this command from the root folder:
```bash
cd lessons/0
```
:::
#### Recap #### Recap
If you chose to do a local installation, then by now you should have the following available on your system: If you chose to do a local installation, then by now you should have the following available on your system:

View file

@ -1,14 +1,3 @@
# Getting started # Getting started
This section includes introductory lessons including concepts found commonly in qsv and command-line usage. If you're new to qsv or want to follow the exercises in order, continue on to the first lesson. This section includes introductory lessons including concepts found commonly in qsv and command-line usage. If you're new to qsv or want to follow the exercises in order, continue on to the first lesson.
:::{admonition} Reminder for each exercise
:class: important
If you're running exercises locally then make sure you change your directory (`cd`) into the relevant directory in the `lessons` folder for each exercise. For example for the first exercise you may run this command from the root folder:
```bash
cd lessons/0
```
:::

View file

@ -70,7 +70,7 @@ Now it's your turn to take on the first exercise.
Using a qsv command, get the total number of rows that are in the `fruits.csv` file. Using a qsv command, get the total number of rows that are in the `fruits.csv` file.
> Here we list qsv commands for your reference. Solve this exercise using [Thebe](exercises-setup:thebe), [Binder](exercises-setup:binder), or [locally](exercises-setup:local). > Here we list qsv commands for your reference. Solve this exercise using [Thebe](exercises-setup:thebe) or [locally](exercises-setup:local).
```{code-cell} ```{code-cell}
:tags: ["scroll-output"] :tags: ["scroll-output"]

View file

@ -1,2 +1 @@
jupyter-book jupyter-book
jupyterlab_myst