Skip to content

Commit

Permalink
add expected runtime in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
quentinblampey committed Mar 7, 2024
1 parent c0957e5 commit 7a80581
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
4 changes: 3 additions & 1 deletion docs/tutorials/api_usage.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@
"source": [
"## Save the `SpatialData` object\n",
"\n",
"For this tutorial, we use a generated dataset. The command below will generate and save it on disk (you can change the path `tuto.zarr` to save it somewhere else).\n",
"For this tutorial, we use a generated dataset. You can expect a total runtime of a few minutes.\n",
"\n",
"The command below will generate and save it on disk (you can change the path `tuto.zarr` to save it somewhere else).\n",
"\n",
"See the commented lines below to load your own data, or see the [`sopa.io` API](../../api/io)."
]
Expand Down
4 changes: 3 additions & 1 deletion docs/tutorials/cli_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@ Here, we provide a minimal example of command line usage. For more details and t

## Save the `SpatialData` object

For this tutorial, we use a generated dataset. The command below will generate and save it on disk (you can change the path `tuto.zarr` to save it somewhere else). If you want to load your own data: choose the right panel below, or see the [`sopa read` CLI documentation](`../../cli/#sopa-read`).
For this tutorial, we use a generated dataset. You can expect a total runtime of a few minutes.

The command below will generate and save it on disk (you can change the path `tuto.zarr` to save it somewhere else). If you want to load your own data: choose the right panel below, or see the [`sopa read` CLI documentation](`../../cli/#sopa-read`).

=== "Tutorial"
```sh
Expand Down

0 comments on commit 7a80581

Please sign in to comment.