Skip to content

Commit 097a2a6

Browse files
More tutorial notebooks for plotting (#256)
* add small random noise to drifter release locations * first updates to argo and drifter plotting notebooks * enhancements to drifter plotting * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * add limit to offset which can be added * update test to account for x,y offsets * hide old notebooks from docs tutorials * add waypoint locations to plot and more guidance through notebook * generic data dir path * clean up text * update argo/drifter plotting tutorial * refactor tutorial headings for consistency and clarity * new argo plotting tutorial * new xbt plotting tutorial * adjust default data dir path * remove unnecessary imports * small edits * new underway st tutorial, plus update index.md * update sail the ship to point to tutorials for plotting help * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 982f91c commit 097a2a6

8 files changed

Lines changed: 1120 additions & 174 deletions

File tree

docs/user-guide/assignments/Sail_the_ship.ipynb

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,11 @@
229229
"\n",
230230
"If this is your first time running VirtualShip, you will be prompted to enter your own Copernicus Marine Data Store credentials (these will be saved automatically for future use).\n",
231231
"\n",
232-
"Small simulations (e.g. small space-time domains and fewer instrument deployments) will be relatively fast. For large, complex expeditions, it _could_ take up to an hour to simulate the measurements depending on your choices. Waiting for simulation is a great time to practice your level of patience. A skill much needed in oceanographic fieldwork ;-)"
232+
"Small simulations (e.g. small space-time domains and fewer instrument deployments) will be relatively fast. For large, complex expeditions, it _could_ take up to an hour to simulate the measurements depending on your choices. Waiting for simulation is a great time to practice your level of patience. A skill much needed in oceanographic fieldwork ;-)\n",
233+
"\n",
234+
"<div class=\"alert alert-block alert-success\"> \n",
235+
"**TIP**: Not using underway instruments will speed up the simulation time considerably. So, if you do not plan to use underway temperature/salinity or ADCP measurements, make sure to switch these off in the planning tool before running the expedition.\n",
236+
"</div>"
233237
]
234238
},
235239
{
@@ -240,9 +244,11 @@
240244
"\n",
241245
"Upon successfully completing the simulation, results from the expedition will be stored in the `EXPEDITION_NAME/results` directory, written as [Zarr](https://zarr.dev/) files.\n",
242246
"\n",
243-
"From here you can carry on your post-processing analysis, **but we will focus more on this in the next VirtualShip classroom session**.\n",
247+
"From here you can carry on your analysis. In general, we encourage you to explore and analyse these data using [Xarray](https://docs.xarray.dev/en/stable/). We also provide various further [VirtualShip tutorials](https://virtualship.readthedocs.io/en/latest/user-guide/tutorials/index.html) which provide examples of how to visualise data recorded by the VirtualShip instruments. Use these to help you get started!\n",
248+
"\n",
249+
"If you are using VirtualShip in class, the same tutorial notebooks will be uploaded in your SURF RC environment for you to use and interact directly with the code. These should be available in e.g. the `data/storage-osl/tutorials/` directory. You will notice that there is a notebook file dedicated to visualising each of the different instruments available in VirtualShip. \n",
244250
"\n",
245-
"In general, we encourage you to explore and analyse these data using [Xarray](https://docs.xarray.dev/en/stable/). We also provide various further [VirtualShip tutorials](https://virtualship.readthedocs.io/en/latest/user-guide/tutorials/index.html) which provide examples of how to visualise data recorded by the VirtualShip instruments."
251+
"To run these notebooks with your own data, you will need to copy the them over to your expedition working directory (i.e. `data/storage-osl/{your-group-name}`). This can be done by either 1) using the file explorer panel in JupyterLab to copy the relevant files or the via the command line in Terminal. In the terminal, running `cp -r /data/storage-osl/tutorials/* /data/storage-osl/{your-group-name}/` would copy __all__ the tutorial notebooks to your group's directory, so if you only want to copy specific ones, make sure to adjust the command accordingly."
246252
]
247253
},
248254
{

docs/user-guide/tutorials/Argo_data_tutorial.ipynb

Lines changed: 384 additions & 49 deletions
Large diffs are not rendered by default.

docs/user-guide/tutorials/Drifter_data_tutorial.ipynb

Lines changed: 249 additions & 117 deletions
Large diffs are not rendered by default.

docs/user-guide/tutorials/Ship_underwater_ST_plotting.ipynb

Lines changed: 256 additions & 0 deletions
Large diffs are not rendered by default.
17.2 KB
Loading
124 KB
Loading

docs/user-guide/tutorials/index.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,23 @@
33
```{nbgallery}
44
---
55
maxdepth: 1
6-
caption: Tutorials
6+
caption: Post-processing results
77
---
8-
surf_research_cloud_setup.ipynb
9-
surf_collaborative_setup.ipynb
10-
ADCP_data_tutorial.ipynb
11-
CTD_data_tutorial.ipynb
8+
<!-- ADCP_data_tutorial.ipynb -->
9+
<!-- CTD_data_tutorial.ipynb -->
1210
Drifter_data_tutorial.ipynb
1311
Argo_data_tutorial.ipynb
1412
CTD_transects.ipynb
1513
ADCP_transects.ipynb
14+
xbt_plotting.ipynb
15+
Ship_underwater_ST_plotting.ipynb
16+
```
17+
18+
```{nbgallery}
19+
---
20+
maxdepth: 1
21+
caption: SURF Research Cloud set up
22+
---
23+
surf_research_cloud_setup.ipynb
24+
surf_collaborative_setup.ipynb
1625
```

docs/user-guide/tutorials/xbt_plotting.ipynb

Lines changed: 208 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)