Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
58 commits
Select commit Hold shift + click to select a range
1fe4e6e
change to parquet info in results section
j-atkins Aug 7, 2026
74eef40
add note/warning that example implementations may be out of date
j-atkins Aug 7, 2026
70e65f4
provide section headings
j-atkins Aug 7, 2026
0fb427c
updates to ADCP tutorial; including per-waypoint alpha calculation
j-atkins Aug 7, 2026
80d5b4e
further enhancements
j-atkins Aug 7, 2026
60fc58c
remove out of date tutorials
j-atkins Aug 7, 2026
68143e7
add .head() display
j-atkins Aug 7, 2026
2903716
further clarifications
j-atkins Aug 7, 2026
54ea641
dummy data path
j-atkins Aug 7, 2026
800c47f
update drifter plotting tutorial
j-atkins Aug 10, 2026
2f7cd0d
restore dummy data path
j-atkins Aug 10, 2026
196a7c5
fix drifter lifetimes calculation
j-atkins Aug 10, 2026
8f03acd
remove initial sampling from argo floats
j-atkins Aug 10, 2026
28e1133
update argo float plotting tutorial
j-atkins Aug 10, 2026
26d6681
argo kernel: solve issue of not updating cycle_age during ascent
j-atkins Aug 10, 2026
1648832
re-render plots with ascent cycle_age fix implemented
j-atkins Aug 10, 2026
ab242ea
furhter fixes to ADCP tutorial
j-atkins Aug 10, 2026
4d5c623
update CTD transect tutorial
j-atkins Aug 10, 2026
6a51c60
update underwaterST plotting tutorial
j-atkins Aug 10, 2026
8d0439e
tidy up imports
j-atkins Aug 10, 2026
cee16bf
update XBT plotting tutorial
j-atkins Aug 10, 2026
0f7fc32
change to parquet info in results section
j-atkins Aug 7, 2026
f9c73d2
add note/warning that example implementations may be out of date
j-atkins Aug 7, 2026
d211949
provide section headings
j-atkins Aug 7, 2026
262083c
updates to ADCP tutorial; including per-waypoint alpha calculation
j-atkins Aug 7, 2026
3616f89
further enhancements
j-atkins Aug 7, 2026
41eba38
remove out of date tutorials
j-atkins Aug 7, 2026
20a3cf9
add .head() display
j-atkins Aug 7, 2026
86dc868
further clarifications
j-atkins Aug 7, 2026
c5049b9
dummy data path
j-atkins Aug 7, 2026
036f75e
update drifter plotting tutorial
j-atkins Aug 10, 2026
10fe59c
restore dummy data path
j-atkins Aug 10, 2026
84fb6ea
fix drifter lifetimes calculation
j-atkins Aug 10, 2026
dcc1b06
update argo float plotting tutorial
j-atkins Aug 10, 2026
927bebd
re-render plots with ascent cycle_age fix implemented
j-atkins Aug 10, 2026
bde44bb
furhter fixes to ADCP tutorial
j-atkins Aug 10, 2026
0ac4f00
update CTD transect tutorial
j-atkins Aug 10, 2026
cc352c4
update underwaterST plotting tutorial
j-atkins Aug 10, 2026
5e46ea2
tidy up imports
j-atkins Aug 10, 2026
34626bf
update XBT plotting tutorial
j-atkins Aug 10, 2026
7962b1e
Merge branch 'update-docs' of github.com:OceanParcels/virtualship int…
j-atkins Aug 10, 2026
2a59575
remove surf collaborative version whilst this option is unviable
j-atkins Aug 10, 2026
dce3aea
update sail the ship instructions
j-atkins Aug 11, 2026
58455c0
add requirement that depth must have "positive" attr
j-atkins Aug 11, 2026
b33a5eb
remove duplicate sensors list page
j-atkins Aug 11, 2026
3aec25c
updates to ADCP tutorial; including per-waypoint alpha calculation
j-atkins Aug 7, 2026
c48d034
add .head() display
j-atkins Aug 7, 2026
e52300f
dummy data path
j-atkins Aug 7, 2026
af6b726
update drifter plotting tutorial
j-atkins Aug 10, 2026
91c2283
restore dummy data path
j-atkins Aug 10, 2026
2860ca6
furhter fixes to ADCP tutorial
j-atkins Aug 10, 2026
05d854b
update underwaterST plotting tutorial
j-atkins Aug 10, 2026
5d2de5b
remove surf collaborative version whilst this option is unviable
j-atkins Aug 10, 2026
208cb39
update sail the ship instructions
j-atkins Aug 11, 2026
c01c1a3
add requirement that depth must have "positive" attr
j-atkins Aug 11, 2026
abc2813
remove duplicate sensors list page
j-atkins Aug 11, 2026
2a0149f
fix typo
j-atkins Aug 11, 2026
60de243
Merge branch 'update-docs' of github.com:OceanParcels/virtualship int…
j-atkins Aug 11, 2026
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
10 changes: 3 additions & 7 deletions docs/user-guide/assignments/Sail_the_ship.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -251,10 +251,6 @@
"\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 ;-)\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>\n",
"\n",
"<div class=\"alert alert-block alert-warning\"> \n",
"**Important**: VirtualShip may encounter 'real-life challenges' during the expedition, which simulate the various problems and unexpected events that can occur during real-life oceanographic expeditions (e.g. instrument and/or equipment failure, logistical challenges etc.). These may require your intervention to ensure your expedition schedule can continue!\n",
"</div>"
Expand All @@ -266,11 +262,11 @@
"source": [
"## 7) Results\n",
"\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",
"Upon successfully completing the simulation, results from the expedition will be stored in the `EXPEDITION_NAME/results` directory, written in `.parquet` [format](https://parquet.apache.org/).\n",
"\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",
"From here you can carry on your analysis. In general, we encourage you to use [Parcels](https://Parcels-code.org/) (i.e. `parcels.read_particlefile()`) to read in VirtualShip output files, and tools such as [Polars](https://www.pola.rs/) and/or [Pandas](https://pandas.pydata.org/) for further data analysis. 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/tutorials/` directory. You will notice that there is a notebook file dedicated to visualising each of the different instruments available in VirtualShip. \n",
"If you are using VirtualShip in class, the same tutorial notebooks may 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/tutorials/` directory. You will notice that there is a notebook file dedicated to visualising each of the different instruments available in VirtualShip. \n",
"\n",
"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/{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/tutorials/* /data/storage/{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
1 change: 1 addition & 0 deletions docs/user-guide/documentation/pre_download_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ The following assumptions are also made about the data:
3. If using BGC-enabled instruments (e.g. BGC variables on the `CTD`), the relevant biogeochemical data files must contain the following variables: `o2`, `chl`, `no3`, `po4`, `nppv`, `ph`, `phyc`.
- Or these strings must appear as substrings within the variable names (e.g. `o2_glor` is acceptable for `o2`).
4. Bathymetry data files must contain a variable named `deptho`.
5. Pre-downloaded data files must have a `"positive"` attribute for the depth dimension (e.g. `"positive": "down"` or `"positive": "up"`) in order to ensure that the depth dimension is correctly interpreted by Parcels under-the-hood.

#### Also of note

Expand Down
1 change: 0 additions & 1 deletion docs/user-guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,4 @@ documentation/full_sensor_list.md
documentation/copernicus_products.md
documentation/pre_download_data.md
documentation/example_copernicus_download.ipynb
documentation/full_sensor_list.md
```
6 changes: 4 additions & 2 deletions docs/user-guide/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,8 @@ See the relevant [documentation](https://virtualship.readthedocs.io/en/latest/us

## 5) Results

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.
Upon successfully completing the simulation, results from the expedition will be stored in the `EXPEDITION_NAME/results` directory, written in `.parquet` [format](https://parquet.apache.org/).

From here you can carry on your analysis (offline). 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.
From here you can carry on your analysis (offline). We encourage you to use [Parcels](https://Parcels-code.org/) (i.e. `parcels.read_particlefile()`) to read in VirtualShip output files, and tools such as [Polars](https://www.pola.rs/) and/or [Pandas](https://pandas.pydata.org/) for further data analysis.

We also provide various [VirtualShip tutorials](https://virtualship.readthedocs.io/en/latest/user-guide/tutorials/index.html) with further examples of how to visualise data recorded by the VirtualShip instruments.
17 changes: 14 additions & 3 deletions docs/user-guide/teacher-content/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Teacher content

### Overview

VirtualShip is used as part of the VirtualShip Classroom, that combines authentic tools with VR to create a virtual fieldwork experience and allows you to teach about sea-based research from your regular classroom.

All VirtualShip Classroom (VSC) material is open under an MIT licence and freely available! You can use the VSC to teach anything from a 4 hour masterclass up to an open assignment of more than 40 hours. Example assignments are available below and please feel free to customize anything offline or [contribute](../../contributing/index.md) to the assignments provided here.
Expand All @@ -16,17 +18,26 @@ The VSC design focuses on creating didactically sound, authentic learning experi

We evaluated in several (under)graduate courses and find that the VirtualShip Classroom is highly engaging, and students report on enhanced confidence and knowledge [(Daniels et al. 2025)](https://current-journal.com/articles/10.5334/cjme.121).

### Teaching materials

```{toctree}
:maxdepth: 1
:caption: Teaching materials

ILOs.ipynb
letter.md
```

### Previous implementations

```{warning}
The following implementations are examples of how the VSC has been used in the past. They are provided here for reference only and may not be up to date with the latest version of the VSC and/or VirtualShip software.
```

#### Utrecht University

```{nbgallery}
---
caption: UU Ocean of the Future
caption: Ocean of the Future (BSc), 2025-26
---
UU-ocean-of-future/Tutorial1.ipynb
UU-ocean-of-future/CoordinatesExport-Transect.xlsx
Expand All @@ -37,7 +48,7 @@ UU-ocean-of-future/plot_slider.py

```{nbgallery}
---
caption: UU Dynamical Oceanography
caption: Dynamical Oceanography (MSc), 2025-26
---
UU-dyoc/example_expedition.md
UU-dyoc/file_permissions.md
Expand Down
Loading