From 4ae71ec3ad2c560f97d98dec0ffee06493009eeb Mon Sep 17 00:00:00 2001 From: j-atkins <106238905+j-atkins@users.noreply.github.com> Date: Thu, 28 May 2026 15:47:29 +0100 Subject: [PATCH 1/4] update project owner and some phrasing in README --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index ddf444d4..094d19c5 100644 --- a/README.md +++ b/README.md @@ -21,13 +21,13 @@ - - + + - +
Project OwnerEmma Daniels (e.e.daniels1@uu.nl)VirtualShip Teamvirtualship@uu.nl
Development statusAlphaBeta
@@ -35,20 +35,20 @@ -VirtualShip is a command line simulator allowing students to plan and conduct a virtual research expedition, receiving measurements as if they were coming from actual oceanographic instruments including: +VirtualShip is a command line simulator allowing scientists to plan and conduct a research expedition in a digital ocean, receiving measurements as if they were coming from actual oceanographic instruments including: - ADCP (currents) - CTD (conductivity and temperature + biogeochemical variables) - XBT (temperature) - Ship-mounted underwater measurements (salinity and temperature) -- Surface drifters -- Argo float deployments +- Surface drifters (temperature) +- Argo float deployments (salinity and temperature) -Along the way, students will encounter realistic problems that may occur during an oceanographic expedition, requiring them to make decisions to adapt their plans accordingly. For example, delays due to equipment failures, pre-depature logistical issues or safety drills. +Along the way, users will encounter realistic problems that may occur during an oceanographic expedition, requiring them to make decisions to adapt their plans accordingly. For example, delays due to equipment failures, pre-depature logistical issues or safety drills. ## Installation -For a normal installation do: +For a normal installation using Conda do: ```bash conda create -n ship -c conda-forge virtualship @@ -57,7 +57,7 @@ conda activate ship which creates an environment named `ship` with the latest version of `virtualship`. You can replace `ship` with any name you like. -For a development installation, please follow the instructions detailed in the [contributing page](https://virtualship.readthedocs.io/en/latest/contributing/index.html). +For a development installation (using Pixi), please follow the instructions detailed in the [contributing page](https://virtualship.readthedocs.io/en/latest/contributing/index.html). ## Usage @@ -137,7 +137,7 @@ For examples of VirtualShip simulation output post-processing, see [the tutorial ## Input data -The scripts are written to work with [A-grid ocean data from the Copernicus Marine Service](https://data.marine.copernicus.eu/product/GLOBAL_ANALYSISFORECAST_PHY_001_024/description). +The code is written to work with [A-grid ocean data from the Copernicus Marine Service](https://data.marine.copernicus.eu/product/GLOBAL_ANALYSISFORECAST_PHY_001_024/description). ## Source code From dfaf48c168b23f555459d77b0967b6bb50aefee0 Mon Sep 17 00:00:00 2001 From: j-atkins <106238905+j-atkins@users.noreply.github.com> Date: Thu, 28 May 2026 15:49:06 +0100 Subject: [PATCH 2/4] update copyrights --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index c93f3c5e..6fb9916e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -3,8 +3,8 @@ import importlib.metadata project = "VirtualShip Parcels" -copyright = "2024, Emma Daniëls" -author = "Emma Daniëls" +copyright = "2024, VirtualShip Team" +author = "VirtualShip Team" version = release = importlib.metadata.version("virtualship") extensions = [ From ba451d7a1991fd0748ba58a19ddc9acf149777e6 Mon Sep 17 00:00:00 2001 From: j-atkins <106238905+j-atkins@users.noreply.github.com> Date: Thu, 28 May 2026 15:53:29 +0100 Subject: [PATCH 3/4] fix formatting --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 094d19c5..89905020 100644 --- a/README.md +++ b/README.md @@ -21,8 +21,8 @@ - - + + From b3529766ce2161b4cb673e494ed41d54de055a92 Mon Sep 17 00:00:00 2001 From: j-atkins <106238905+j-atkins@users.noreply.github.com> Date: Thu, 28 May 2026 15:58:34 +0100 Subject: [PATCH 4/4] change tip box formatting to suit both github repo and sphinx docs --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 89905020..c66ab2fc 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,8 @@ For a development installation (using Pixi), please follow the instructions deta ## Usage -> [!TIP] +> **💡 Tip** +> > See the [Quickstart guide](https://virtualship.readthedocs.io/en/latest/user-guide/quickstart.html) in our documentation for a step-by-step introduction to using VirtualShip. You can run the VirtualShip via the command line interface (CLI) using the `virtualship` command. It has three subcommands: `init`, `plan`, and `run`.
VirtualShip Teamvirtualship@uu.nlProject OwnerVirtualShip Team (virtualship@uu.nl)