Skip to content

Commit b1b2e0e

Browse files
Merge pull request #166 from lshaw8317/updateDocs
Fix errors in docs
2 parents 0936e85 + 6b9938e commit b1b2e0e

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

doc/tutorials/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
maxdepth: 2
77
---
88
9-
launching-services
109
API
11-
cli
1210
web-client
11+
cli
12+
launching-services
1313
configuration
1414
independent-services
1515
```

doc/tutorials/web-client.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Searching for datasets
3737
## User authentication and personal space
3838

3939
Up until now we've just seen the read-only operations that may be performed on the cat2cloud server. However, as an authenticated user one may perform several write operations that we'll see next.
40-
Returning to <https://cat2.cloud/demo>, click on "Sign in" and you will be taken to the login screen. First create a user via the "Sign up" link, and the sign in with the same credentials and click on "Login".
40+
Returning to <https://cat2.cloud/demo>, click on "Sign in" and you will be taken to the login screen. First create a user via the "Sign up" link, and then sign in with the same credentials and click on "Login".
4141

4242
```{figure} images/web-login.webp
4343
---
@@ -49,7 +49,7 @@ scale: 75%
4949
The login screen
5050
```
5151

52-
The main Web client screen has some changes now: besides the indication of the logged in user, one has access to two additional roots called `@personal` and `@shared`. In addition, an upload button has appeared beside each of the three roots, and a prompt box has appeared above the datasets section:
52+
The main Web client screen has some changes now: besides the indication of the logged-in user, one has access to two additional roots called `@personal` and `@shared`. In addition, an upload button has appeared beside each of the three roots, and a prompt box has appeared above the datasets section:
5353

5454
```{figure} images/web-roots.webp
5555
---
@@ -82,7 +82,7 @@ You may now use the uploaded dataset as a normal one: download it, view its data
8282

8383
## Accessing a dataset
8484

85-
Click on `@public/examples/lung-jpeg2000_10x.b2nd`, and you shall get the full name (path) of the dataset and a set of tabs. The default one shows the main information of the dataset, including a download link for you to save the whole dataset to your computer, plus the metadata that we got from clients in previous sections, all in a nicely formatted table.
85+
Click on `@public/examples/lung-jpeg2000_10x.b2nd`, and you shall get the full name (path) of the dataset and a set of tabs. The default tab shows the main information of the dataset, including a download link for you to save the whole dataset to your computer, plus the metadata that we got from clients in previous sections, all in a nicely formatted table.
8686

8787
```{figure} images/web-main.webp
8888
---
@@ -128,7 +128,7 @@ class: with-border
128128
129129
Displaying Markdown text
130130
```
131-
Display support for other kinds of datasets, such as jpg files, is also supported.
131+
Other kinds of datasets, such as jpg files, also have display support.
132132

133133
## Computing expressions on datasets
134134

@@ -146,7 +146,7 @@ The most powerful set of commands are those implemented via "lazy expressions",
146146

147147
First, let's select the dataset `@personal/localfile.b2nd` that we uploaded and view its data. Now select the dataset `@personal/ds-1d.b2nd`, an array of the same shape. In fact, lazy expressions support broadcasting, so the two datasets can be of different shapes, as long as they are compatible.
148148

149-
Let's create an expression that adds them together into a new dataset that we'll call `sum_of_arrays`. The command box accepts Python-like expressions, and we refer to the added datasets acting as operands using the tag that appears next to their name in the dataset list. In our case, `@personal/localfile.b2nd` is tagged as `a`, and `@personal/ds-1d.b2nd` as `j`, thus the command to be entered in the command box is `sum_of_arrays = a + j`. Entering the command and clicking on "GO" creates a new dataset (a `LazyExpr`) `@personal/sum_of_arrays.b2nd` which should be shown instantly.
149+
Let's create an expression that adds them together into a new dataset that we'll call `out`. The command box accepts Python-like expressions, and we refer to the datasets acting as operands using the tag that appears next to their name in the dataset list. In our case, `@personal/localfile.b2nd` is tagged as `a`, and `@personal/ds-1d.b2nd` as `h`, thus the command to be entered in the command box is `out = a + h`. Entering the command and clicking on "GO" creates a new dataset (a `LazyExpr`) `@personal/out.b2nd` which should be shown instantly.
150150

151151
```{figure} images/web-lazyexpr.webp
152152
---
@@ -158,9 +158,9 @@ class: with-border
158158
The newly created lazy expression
159159
```
160160

161-
The dataset has very reduced metadata that just describes its shape, type, expression and operands. However, you may still use it as any other dataset, e.g. to view its data (which will be computed on-the-fly), have it participate in other lazy expressions, or download it (with fully computed data) to your device. Naturally, it can also be deleted.
161+
The dataset has very reduced metadata that just describes its shape, type, expression and operands. However, it will behave like any other server-hosted dataset, and you may e.g. view its data (which will be computed on-the-fly), have it participate in other lazy expressions, or download it (with fully computed data) to your device. Naturally, it can also be deleted.
162162

163-
Lazy expressions are a very versatile tool to have complex computations performed by a powerful and well-connected machine (the server), and get the result to your device once satisfied with the result. Many [arithmetic and reduction operations][b2-lazyexpr] are supported, just play with them and find out!
163+
Lazy expressions are a very versatile tool. Using them, one may perform complex computations on a powerful and well-connected machine (the server), and download the result to your device once satisfied with the operations. Many [arithmetic and reduction operations][b2-lazyexpr] are supported, just play around with them and find out!
164164

165165
[b2-lazyexpr]: https://www.blosc.org/python-blosc2/getting_started/tutorials/02.lazyarray-expressions.html
166166
"LazyArray: Expressions containing NDArray objects (and others) (Python-Blosc2 documentation)"

0 commit comments

Comments
 (0)