Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 6 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,11 +70,13 @@
always_document_param_types = True

nbsphinx_thumbnails = {
"user-guide/quickstart": "user-guide/_images/AnnaWeber.jpeg",
"user-guide/tutorials/index": "user-guide/_images/AnnaWeber.jpeg",
"user-guide/assignments/Research_proposal_intro": "user-guide/_images/MFPtimeline.jpg",
"user-guide/assignments/Research_Proposal_only": "user-guide/_images/MFP.jpg",
"user-guide/assignments/Virtualship_research_proposal": "user-guide/_images/AnnaWeber.jpeg",
"user-guide/assignments/sciencecommunication_assignment": "user-guide/_images/marine_ss.jpg",
"user-guide/assignments/Sail_the_ship": "user-guide/_images/freepik_research_vessel.jpg",
"user-guide/assignments/sail_the_ship": "user-guide/_images/freepik_research_vessel.jpg",
"user-guide/assignments/Code_of_conduct": "user-guide/_images/freepik_code_of_conduct.jpg",
"user-guide/teacher-content/ILOs": "user-guide/_images/ILOs.jpg",
"user-guide/teacher-content/UU-ocean-of-future/Tutorial1": "user-guide/_images/freepik_assignment.png",
Expand All @@ -84,6 +86,9 @@
"user-guide/tutorials/working_with_expedition_yaml": "user-guide/_images/AnnaWeber.jpeg",
"user-guide/teacher-content/UU-dyoc/example_expedition": "user-guide/_images/AnnaWeber.jpeg",
"user-guide/teacher-content/UU-dyoc/file_permissions": "user-guide/_images/AnnaWeber.jpeg",
"user-guide/teacher-content/train-the-teacher/surf_set_up": "user-guide/_images/AnnaWeber.jpeg",
"user-guide/teacher-content/train-the-teacher/file_permissions": "user-guide/_images/AnnaWeber.jpeg",
"user-guide/teacher-content/train-the-teacher/surf_student_access": "user-guide/_images/AnnaWeber.jpeg",
}

sphinx_gallery_conf = {"default_thumb_file": "_static/virtual_ship_logo.png"}
Expand Down
322 changes: 0 additions & 322 deletions docs/user-guide/assignments/Sail_the_ship.ipynb

This file was deleted.

220 changes: 220 additions & 0 deletions docs/user-guide/assignments/sail_the_ship.md

Large diffs are not rendered by default.

366 changes: 366 additions & 0 deletions docs/user-guide/teacher-content/Drifter_data_tutorial.ipynb

Large diffs are not rendered by default.

15 changes: 14 additions & 1 deletion docs/user-guide/teacher-content/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,20 @@ 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
### Train the teacher

This section provides a step-by-step guide for teachers to get started with the VirtualShip Classroom. It includes instructions on how to set up the software, navigate the tooling, and use the teaching materials effectively.

```{toctree}
:maxdepth: 2

train-the-teacher/train_the_teacher.md

```

### Further teaching materials

<!-- TODO: this section (along with the rest of the docs) needs more context/guidance -->

```{toctree}
:maxdepth: 1
Expand Down
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.
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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Learner guide: File Permissions on the SURF Research Cloud

The shared storage directory in the SURF RC virtual machine (e.g. `data/virtualship-storage/`) is configured such that all users of the workspace can read and access the files within it, but only the owner of a file can edit it. This can prevent seamless collaboration on the same expedition content, for example within your group.

## How to share and edit files

To enable collaboration on expedition content within your group, you can change the permissions of files within the shared storage directory to allow editing by all users. This can be done using the `chmod` command in the terminal (see [here](https://en.wikipedia.org/wiki/Chmod) for more detail on the `chmod` command).

For example, for your `expedition.yaml` file, you can run the following command in the terminal (after navigating to your group's directory and replacing `EXPEDITION_NAME` with your actual expedition directory):

```
chmod 777 /EXPEDITION_NAME/expedition.yaml
```

This will allow _all_ users in the SURF environment to edit the `expedition.yaml` file. You can repeat this process for any other files within the shared storage that you wish to collaborate on with your group members.

```{warning}
Be careful when using `chmod 777`, as it grants read, write, and execute permissions to **all** users. This means _everyone_ who has access to the SURF environment can edit the file (i.e. the whole class), which could cause accidental changes or deletions if not used carefully. We recommend you make backups of important files before changing permissions.

This is generally fine for the purposes of this classroom activity where the virtual environment is a controlled setting, but in other contexts, it can pose security risks. Always ensure you understand the implications of changing file permissions and consider more restrictive permissions when necessary.

**TL;DR the `chmod 777` command is fine for this unit, but be very careful when using it in other contexts!**
```

## Reverting the file permissions

If you wish to revert the file permissions back to only allowing the owner to edit, you can run the following command in the terminal:

```
chmod 644 /EXPEDITION_NAME/expedition.yaml
```
79 changes: 79 additions & 0 deletions docs/user-guide/teacher-content/train-the-teacher/lesson_plans.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Example lesson plans

## 1) Using the `VirtualShip` software

This example lesson plan is suitable for students with programming knowledge. Students hand in a short research proposal and expedition plan for feedback. They use the `VirtualShip` software to conduct their virtual expedition and analyse the results. They show their results in a presentation that can be assessed. This assignment is recommended to be undertaken in groups, because collaborative learning is beneficial. Suggested learning goals are that students can:

- identify and address (practical) challenges involved in sea-based research;
- give examples of uncertainty and the synoptic nature of sea-based observations;
- analyze and interpret sea-based observations;
- plan a comprehensive research expedition.

**An example lesson plan is as follows:**

| Background lecture on observing the ocean |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| _1-2 hours depending on the amount of detail, can also be viewed by student before class as preparation_ |
| Presentation about observing and measuring the ocean, covering different types of observations and instruments followed by steps to conduct ocean research. Sample presentation sides are available on [Edusources](https://edusources.nl/materials/90a4df16-427b-4f95-b2c2-b7bc9b2c6b81/presentation-about-observing-and-measuring-the-ocean). |

| Prep work / homework |
| ------------------------------------------------------------------------------------------------------------------ |
| _1 hour of homework_ |
| Introduction to VirtualShip research proposals, available [here](../../assignments/Research_proposal_intro.ipynb). |

| Tutorial 1 |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| _2 hours in class, 4 hours of homework_ |
| Students hand in a short VirtualShip [research proposal](../../assignments/Virtualship_research_proposal.ipynb) for the lecturer (or an expert colleague) to provide feedback. We recommend ensuring that the research questions are focused enough to be researchable in the granted ship time (typically up to three weeks). |

```{note}
Because data are taken from the Copernicus Marine Data Store (see [here](../../documentation/copernicus_products.md) for more technical details), expeditions can take place from 1993 to present (up to 2 weeks into the future).
```

```{tip}
An interesting addition can be to let students use the [MyOcean Pro viewer](https://data.marine.copernicus.eu/viewer/) to, for example, track an eddy using sea surface height and deploy their instruments therein.
```

| Tutorial 2 |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| _4 hours in class_ |
| Students begin their expedition simulations. Please refer back to the main train-the-teacher [documentation](train_the_teacher.md/#sailing-the-ship) for further instructions on running the software in the classroom. |

| VR component |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| A range of 360° videos are available on [YouTube](https://www.youtube.com/@VirtualShipClassroom). If time allows, let students watch one or more of the ship tours and a-day-at-sea videos. |

| Tutorial 3 |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| _2-4 hours in class, 10 hours of homework_ |
| Encourage the students to analyze their own data using the [example tutorials](../../tutorials/index.md). For more advanced courses, students can be asked to produce further, derived quantities as part of their analysis. |

| Presentations |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| _Number of hours in class will depend on the number of groups that present, we suggest at least 10-15 minutes for each group including questions_ |
| Students present their results. An example presentation rubric is available on [Edusources](https://edusources.nl/materials/44ff66eb-537d-4ab9-a844-0fba9bd8d240/rubric-to-grade-advanced-student-presentations). |

## 2) _Not_ using the software

It is also possible to skip using the `VirtuaShip` software entirely and instead use the Open Education Resources (and potentially the VR component) to teach about oceanography and research methods. This is a good option if you want to focus on the learning outcomes without the technical overhead of using the software.

This example lesson plan is suitable for all students, regardless of programming knowledge. Students hand in a research proposal and an accompanying expedition plan that can be assessed. The assignment can be conducted in groups or individually. Suggested learning goals are that students can:

- identify practical challenges of planning sea-based research;
- plan a comprehensive research expedition.

**An example lesson plan is as follows:**

| Background lecture on observing the ocean |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| _1-2 hours depending on the amount of detail, can also be viewed by student before class as preparation_ |
| Presentation about observing and measuring the ocean, covering different types of observations and instruments followed by steps to conduct ocean research. Sample presentation sides are available on [Edusources](https://edusources.nl/materials/90a4df16-427b-4f95-b2c2-b7bc9b2c6b81/presentation-about-observing-and-measuring-the-ocean). |

| Tutorial |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| _2 hours in class, 4-8 hours of homework_ |
| In class, students discuss their research questions and approach with an expert before submitting a VirtualShip [research proposal](../../assignments/Research_Proposal_only.ipynb). This is a good opportunity to invite oceanography experts to share their perspectives and insights, if you are not one yourself. |

| VR component |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| A range of 360° videos are available on [YouTube](https://www.youtube.com/@VirtualShipClassroom). If time allows, let students watch one or more of the ship tours and a-day-at-sea videos. |
Loading
Loading