From 5b382a29e5dd89868c0fe79772ae960aa08cdad7 Mon Sep 17 00:00:00 2001 From: j-atkins <106238905+j-atkins@users.noreply.github.com> Date: Fri, 25 Sep 2026 13:16:10 +0200 Subject: [PATCH 1/5] populate Learner tab --- .../user-profiles/learners/index.md | 140 +++++++++++++++++- 1 file changed, 138 insertions(+), 2 deletions(-) diff --git a/docs/user-guide/user-profiles/learners/index.md b/docs/user-guide/user-profiles/learners/index.md index e8acf13f..0dcbb1af 100644 --- a/docs/user-guide/user-profiles/learners/index.md +++ b/docs/user-guide/user-profiles/learners/index.md @@ -1,3 +1,139 @@ -```{caution} -Coming soon! +# Learners + +## Welcome aboard! 🚢 + +Welcome aboard the VirtualShip! Here you will conduct a research expedition in a digital replica of the global ocean. You'll plan your own expedition, choose where and when to sample, deploy oceanographic instruments (CTDs, Argo floats, drifters, ADCPs and more), and analyse the data you collect. + +Along the way you'll find out how challenging it can be to measure the ocean. The software uses a digital twin of the ocean from the [Copernicus Marine Data Store](https://data.marine.copernicus.eu/products) alongside simulated instruments which behave as in real life. + +## Sail the ship + +The **Sail the Ship** guide is the main guide for your expedition. It takes you step by step from planning your route and configuring your instruments, to running the simulation and reporting your results. + +::::{grid} 1 +:gutter: 4 +:padding: 2 2 0 0 +:class-container: sd-text-center + +````{grid-item-card} Sail the Ship 🚢 +:shadow: md + +Plan, configure and run your VirtualShip expedition, step by step. + ++++ + +```{button-ref} ../../assignments/sail_the_ship +:ref-type: doc +:color: secondary +:expand: + +Sail the Ship ``` +```` + +:::: + +## Technical set up + +### 1) Register with the Copernicus Marine Data Store + +VirtualShip streams ocean data from the Copernicus Marine Data Store, so you will need a free [Copernicus Marine Service account](https://data.marine.copernicus.eu/register). Register before you start, because you will be asked for your credentials the first time you run an expedition. + +### 2) Set up your programming environment + +You will need a programming environment to run the VirtualShip software. Your instructor will give you more instructions but, otherwise, see the following options for how you can do this: + +#### Option 1: with a pre-configured virtual machine + +It is an option to use our **pre-configured cloud-based workspace** on [GitHub Codespaces](https://github.com/features/codespaces), which runs in your web browser and needs no local installation. All you need is a free GitHub account and an internet connection. Follow the Simulation Workspace Guide below to get started. + +```{nbgallery} +--- +maxdepth: 1 +--- +../../tutorials/codespaces_guide.md +``` + +```{important} +The free tier of GitHub Codespaces gives each account a limited number of hours per month. Remember to stop your Codespace when you're not using it so you don't use up your allowance (see the [Simulation Workspace Guide](../../tutorials/codespaces_guide.md) for details). +``` + +#### Option 2: install the software locally + +If your instructor has asked you to install the software on your own computer (or an institutional server) instead, you can create a new conda environment with `VirtualShip` installed as follows: + +```bash +# create a new conda environment called 'virtualship' and install the software from the conda-forge channel +conda create -n virtualship -c conda-forge virtualship + +# activate the environment +conda activate virtualship +``` + +### 3) Post-processing workspace + +When your expedition has finished, you can analyse your results in our **post-processing workspace**. This is a separate, cloud-based JupyterLab environment (hosted on [Binder](https://mybinder.org/)) with all the analysis tools and example tutorials already installed. See the Post-processing Workspace Guide below for how to use it. + +```{note} +You don't have to use the post-processing workspace! Feel free to download your data and analyse it in your own programming environment if you prefer. +``` + +```{nbgallery} +--- +maxdepth: 1 +--- +../../tutorials/binder_guide.md +``` + +## Assignments + +Your instructor will probably direct you to some of the assignments below as part of your course. You are welcome to browse them yourself here as well: + +```{nbgallery} +--- +maxdepth: 1 +--- +../educators/letter.md +../../assignments/case_studies_virtualship.ipynb +../../assignments/Research_proposal_intro.ipynb +../../assignments/Research_Proposal_only.ipynb +../../assignments/Virtualship_research_proposal.ipynb +../../assignments/sciencecommunication_assignment.ipynb +../../assignments/Code_of_conduct.ipynb +``` + +```{tip} +If you're working in a group, we suggest reading and signing the [Code of Conduct](../../assignments/Code_of_conduct.ipynb) with your team before you get started. +``` + +## Post-processing tutorials + +Once you have completed your expedition, these tutorials show how to read in and plot the **output** from each `VirtualShip` instrument. Use them as a starting point for your own analysis. + +```{nbgallery} +--- +maxdepth: 1 +--- +../../tutorials/Drifter_data_tutorial.ipynb +../../tutorials/Argo_data_tutorial.ipynb +../../tutorials/CTD_transects.ipynb +../../tutorials/ADCP_transects.ipynb +../../tutorials/xbt_plotting.ipynb +../../tutorials/Ship_underwater_ST_plotting.ipynb +``` + +## End-of-course survey + +The VirtualShip Classroom is developed by researchers at Utrecht University. At the end of your course, **please complete our short end-of-course survey**. Your experience and participation in the survey will help us improve the learning experience for future students 🙂 + +```{important} +Before taking part, please read the [**Research Participant Information Sheet**](../educators/information_sheet.md). It explains what taking part in the study involves, how your data will be used and stored, and your rights as a participant (taking part is voluntary). + +Once you have finished all VirtualShip activities in your course, fill in the survey here: [**https://survey.uu.nl/jfe/form/SV_0OLu4lKYPyLhAxM**](https://survey.uu.nl/jfe/form/SV_0OLu4lKYPyLhAxM). +``` + +## Feedback & support + +- **For questions about your course**, please ask your instructor first. +- **If you have any problems with the software**, or have feedback or suggestions for improvement, get in touch with the VirtualShip team via our [GitHub issue tracker](https://github.com/Parcels-code/virtualship/issues) or by email at [virtualship@uu.nl](mailto:virtualship@uu.nl). +- **For questions about the research study or your privacy**, see the contact details in the [information sheet](../educators/information_sheet.md). From 2c635c4cadf4f57b4fae2175e8121dc4eff33ac8 Mon Sep 17 00:00:00 2001 From: j-atkins <106238905+j-atkins@users.noreply.github.com> Date: Fri, 25 Sep 2026 13:16:17 +0200 Subject: [PATCH 2/5] fix typo --- docs/user-guide/user-profiles/educators/information_sheet.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/user-profiles/educators/information_sheet.md b/docs/user-guide/user-profiles/educators/information_sheet.md index fe9e22b0..85f86638 100644 --- a/docs/user-guide/user-profiles/educators/information_sheet.md +++ b/docs/user-guide/user-profiles/educators/information_sheet.md @@ -56,6 +56,6 @@ Your participation in this study is voluntary. You will not be paid for your par If you have questions, comments or concerns about this part of the course and/or research project, you can talk to one of the researchers of the VirtualShip Classroom or to the course coordinator. Please contact the VirtualShip Team ([virtualship@uu.nl](virtualship@uu.nl)) or Erik van Sebille ([e.vansebille.uu.nl](e.vansebille.uu.nl)). -If you have questions about your rights while taking part in the study or have concerns about the treatment of other articipants, please write to the secretary of the ethical commission at UU ([etc-beta-geo@uu.nl](etc-beta-geo@uu.nl)). +If you have questions about your rights while taking part in the study or have concerns about the treatment of other participants, please write to the secretary of the ethical commission at UU ([etc-beta-geo@uu.nl](etc-beta-geo@uu.nl)). If you have questions or concerns about your privacy while taking part in the study, please send an email to: [privacy-beta@uu.nl](privacy-beta@uu.nl) or [privacy-geo@uu.nl](privacy-geo@uu.nl). From a8802507ce3b49ad8e343c7913d358769b76d712 Mon Sep 17 00:00:00 2001 From: j-atkins <106238905+j-atkins@users.noreply.github.com> Date: Fri, 25 Sep 2026 16:45:51 +0200 Subject: [PATCH 3/5] add conda install help/links --- docs/user-guide/user-profiles/learners/index.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/user-guide/user-profiles/learners/index.md b/docs/user-guide/user-profiles/learners/index.md index 0dcbb1af..e83c022b 100644 --- a/docs/user-guide/user-profiles/learners/index.md +++ b/docs/user-guide/user-profiles/learners/index.md @@ -60,6 +60,10 @@ The free tier of GitHub Codespaces gives each account a limited number of hours #### Option 2: install the software locally +```{note} +The instructions below use the [conda package manager](https://docs.conda.io/en/latest/) to install the software. If you don't have conda installed, you can download it from [here](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html). Also, see [here](https://docs.conda.io/projects/conda/en/stable/user-guide/getting-started.html) for a guide to using conda. +``` + If your instructor has asked you to install the software on your own computer (or an institutional server) instead, you can create a new conda environment with `VirtualShip` installed as follows: ```bash From 37d00d0865a43001647ee309595b348f5d3c8e72 Mon Sep 17 00:00:00 2001 From: j-atkins <106238905+j-atkins@users.noreply.github.com> Date: Fri, 25 Sep 2026 16:46:18 +0200 Subject: [PATCH 4/5] remove exclamation mark --- docs/user-guide/user-profiles/learners/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/user-profiles/learners/index.md b/docs/user-guide/user-profiles/learners/index.md index e83c022b..cfb09589 100644 --- a/docs/user-guide/user-profiles/learners/index.md +++ b/docs/user-guide/user-profiles/learners/index.md @@ -79,7 +79,7 @@ conda activate virtualship When your expedition has finished, you can analyse your results in our **post-processing workspace**. This is a separate, cloud-based JupyterLab environment (hosted on [Binder](https://mybinder.org/)) with all the analysis tools and example tutorials already installed. See the Post-processing Workspace Guide below for how to use it. ```{note} -You don't have to use the post-processing workspace! Feel free to download your data and analyse it in your own programming environment if you prefer. +You don't have to use the post-processing workspace. Feel free to download your data and analyse it in your own programming environment if you prefer. ``` ```{nbgallery} From fc447482da29d65889ce834c528d46ea4cc84b37 Mon Sep 17 00:00:00 2001 From: j-atkins <106238905+j-atkins@users.noreply.github.com> Date: Fri, 25 Sep 2026 16:46:49 +0200 Subject: [PATCH 5/5] "will probably" -> "may" --- docs/user-guide/user-profiles/learners/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/user-profiles/learners/index.md b/docs/user-guide/user-profiles/learners/index.md index cfb09589..fafb2095 100644 --- a/docs/user-guide/user-profiles/learners/index.md +++ b/docs/user-guide/user-profiles/learners/index.md @@ -91,7 +91,7 @@ maxdepth: 1 ## Assignments -Your instructor will probably direct you to some of the assignments below as part of your course. You are welcome to browse them yourself here as well: +Your instructor may direct you to some of the assignments below as part of your course. You are welcome to browse them yourself here as well: ```{nbgallery} ---