Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
d762721
add small random noise to drifter release locations
j-atkins Nov 28, 2025
a22753b
first updates to argo and drifter plotting notebooks
j-atkins Nov 28, 2025
ce5e133
enhancements to drifter plotting
j-atkins Nov 28, 2025
5775836
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Nov 28, 2025
ea3e69e
add limit to offset which can be added
j-atkins Nov 28, 2025
ecad4b1
update test to account for x,y offsets
j-atkins Nov 28, 2025
e163fb5
Merge branch 'multiple-drifters' of github.com:OceanParcels/virtualsh…
j-atkins Nov 28, 2025
a8cdc52
Merge branch 'multiple-drifters' into notebooks-more-instruments
j-atkins Nov 28, 2025
e87ae7a
hide old notebooks from docs tutorials
j-atkins Nov 28, 2025
c8beb83
add waypoint locations to plot and more guidance through notebook
j-atkins Nov 28, 2025
23425f4
generic data dir path
j-atkins Nov 28, 2025
2e87494
clean up text
j-atkins Nov 28, 2025
903040e
update argo/drifter plotting tutorial
j-atkins Nov 28, 2025
8c6924e
refactor tutorial headings for consistency and clarity
j-atkins Nov 29, 2025
c20578a
new argo plotting tutorial
j-atkins Dec 1, 2025
82e98ac
new xbt plotting tutorial
j-atkins Dec 1, 2025
a31f4b2
adjust default data dir path
j-atkins Dec 1, 2025
0b78b2c
remove unnecessary imports
j-atkins Dec 1, 2025
771988d
Merge branch 'main' into notebooks-more-instruments
j-atkins Dec 1, 2025
6dee5ee
small edits
j-atkins Dec 1, 2025
cb34e31
new underway st tutorial, plus update index.md
j-atkins Dec 1, 2025
99a1743
update sail the ship to point to tutorials for plotting help
j-atkins Dec 1, 2025
989354e
Merge branch 'main' of github.com:OceanParcels/virtualship into noteb…
j-atkins Dec 1, 2025
b27802b
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 1, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions docs/user-guide/assignments/Sail_the_ship.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,11 @@
"\n",
"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",
"\n",
"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 ;-)"
"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",
"\n",
"<div class=\"alert alert-block alert-success\"> \n",
"**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",
"</div>"
]
},
{
Expand All @@ -240,9 +244,11 @@
"\n",
"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",
"\n",
"From here you can carry on your post-processing analysis, **but we will focus more on this in the next VirtualShip classroom session**.\n",
"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",
"\n",
"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",
"\n",
"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."
"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."
]
},
{
Expand Down
433 changes: 384 additions & 49 deletions docs/user-guide/tutorials/Argo_data_tutorial.ipynb

Large diffs are not rendered by default.

366 changes: 249 additions & 117 deletions docs/user-guide/tutorials/Drifter_data_tutorial.ipynb

Large diffs are not rendered by default.

256 changes: 256 additions & 0 deletions docs/user-guide/tutorials/Ship_underwater_ST_plotting.ipynb

Large diffs are not rendered by default.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 14 additions & 5 deletions docs/user-guide/tutorials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,23 @@
```{nbgallery}
---
maxdepth: 1
caption: Tutorials
caption: Post-processing results
---
surf_research_cloud_setup.ipynb
surf_collaborative_setup.ipynb
ADCP_data_tutorial.ipynb
CTD_data_tutorial.ipynb
<!-- ADCP_data_tutorial.ipynb -->
<!-- CTD_data_tutorial.ipynb -->
Drifter_data_tutorial.ipynb
Argo_data_tutorial.ipynb
CTD_transects.ipynb
ADCP_transects.ipynb
xbt_plotting.ipynb
Ship_underwater_ST_plotting.ipynb
```

```{nbgallery}
---
maxdepth: 1
caption: SURF Research Cloud set up
---
surf_research_cloud_setup.ipynb
surf_collaborative_setup.ipynb
```
208 changes: 208 additions & 0 deletions docs/user-guide/tutorials/xbt_plotting.ipynb

Large diffs are not rendered by default.

Loading