Skip to content

Commit f71a54f

Browse files
committed
adapt manuscript to new JOSS scope requirements
1 parent 2fee0f6 commit f71a54f

3 files changed

Lines changed: 33 additions & 25 deletions

File tree

docs/paper/jats/paper.jats

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -173,9 +173,6 @@ a Creative Commons Attribution 4.0 International License (CC BY
173173
Facilities Planning</ext-link> (MFP) tool, giving users the option to
174174
define expedition waypoints via an intuitive web-based mapping
175175
interface.</p>
176-
</sec>
177-
<sec id="functionality">
178-
<title>Functionality</title>
179176
<p><monospace>VirtualShip</monospace> simulates the deployment of
180177
virtual instruments commonly used in oceanographic fieldwork, with
181178
emphasis on realism in how users plan and execute expeditions. For
@@ -200,6 +197,9 @@ a Creative Commons Attribution 4.0 International License (CC BY
200197
et al., 2014</xref>) probes. More detail on each instrument is
201198
available in the
202199
<ext-link ext-link-type="uri" xlink:href="https://virtualship.readthedocs.io/en/latest/user-guide/assignments/Research_proposal_intro.html#Measurement-Options">documentation</ext-link>.</p>
200+
</sec>
201+
<sec id="software-design">
202+
<title>Software design</title>
203203
<p>The software can simulate complex multidisciplinary expeditions.
204204
One example is a virtual expedition across the Agulhas Current and the
205205
South Eastern Atlantic that deploys a suite of instruments to sample
@@ -257,19 +257,6 @@ a Creative Commons Attribution 4.0 International License (CC BY
257257
<p>A full example workflow is outlined in the
258258
<ext-link ext-link-type="uri" xlink:href="https://virtualship.readthedocs.io/en/latest/user-guide/quickstart.html">Quickstart
259259
Guide</ext-link> documentation.</p>
260-
<fig>
261-
<caption><p>Example VirtualShip expedition simulated in July/August
262-
2023. Expedition waypoints displayed via the MFP tool (a), Underway
263-
ADCP measurements (b), Surface drifter releases (c; 90-day lifetime
264-
per drifter), and CTD vertical profiles for temperature (d) and
265-
oxygen (e). Black triangles in b), d) and e) mark waypoint locations
266-
across the expedition route, corresponding to the purple markers in
267-
a).<styled-content id="figU003Afig1"></styled-content></p></caption>
268-
<graphic mimetype="image" mime-subtype="png" xlink:href="figure1.png" />
269-
</fig>
270-
</sec>
271-
<sec id="implementation">
272-
<title>Implementation</title>
273260
<p>Under the hood, <monospace>VirtualShip</monospace> is modular and
274261
extensible. The workflows are designed around
275262
<monospace>Instrument</monospace> base classes and instrument-specific
@@ -299,9 +286,19 @@ a Creative Commons Attribution 4.0 International License (CC BY
299286
<ext-link ext-link-type="uri" xlink:href="https://virtualship.readthedocs.io/en/latest/user-guide/documentation/pre_download_data.html">option</ext-link>
300287
for the user to specify local <monospace>NetCDF</monospace> files for
301288
data ingestion, if preferred.</p>
289+
<fig>
290+
<caption><p>Example VirtualShip expedition simulated in July/August
291+
2023. Expedition waypoints displayed via the MFP tool (a), Underway
292+
ADCP measurements (b), Surface drifter releases (c; 90-day lifetime
293+
per drifter), and CTD vertical profiles for temperature (d) and
294+
oxygen (e). Black triangles in b), d) and e) mark waypoint locations
295+
across the expedition route, corresponding to the purple markers in
296+
a).<styled-content id="figU003Afig1"></styled-content></p></caption>
297+
<graphic mimetype="image" mime-subtype="png" xlink:href="figure1.png" />
298+
</fig>
302299
</sec>
303-
<sec id="applications-and-future-outlook">
304-
<title>Applications and future outlook</title>
300+
<sec id="research-impact-statement">
301+
<title>Research impact statement</title>
305302
<p><monospace>VirtualShip</monospace> has already been extensvely
306303
applied in Master’s teaching settings at Utrecht University as part of
307304
the
@@ -351,6 +348,15 @@ a Creative Commons Attribution 4.0 International License (CC BY
351348
capabilities, extensibility and compatability with modern cloud-based
352349
data pipelines.</p>
353350
</sec>
351+
<sec id="ai-usage-disclosure">
352+
<title>AI usage disclosure</title>
353+
<p>Generative AI technologies (Gemini v2.0/2.5/3.0, ChatGPT
354+
v4o/5.0/5.1/5.2 and GitHub Copilot) were used for code generation,
355+
refactoring and test scaffolding. AI-assisted autocompletion tools
356+
(via GitHub Copilot) were used in the writing of this manuscript.
357+
Authors carefully reviewed and edited all AI-assisted content and made
358+
the core desigin decisions.</p>
359+
</sec>
354360
<sec id="acknowledgements">
355361
<title>Acknowledgements</title>
356362
<p>The VirtualShip project is funded through the Utrecht

docs/paper/paper.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,10 @@ Marine science relies on fieldwork for data collection, yet sea-going opportunit
4747

4848
`VirtualShip` goes beyond simply extracting grid-cell values from model output. Instead, it uses programmable behaviours and sophisticated interpolation techniques (with `Parcels` underpinnings) to access data in exact locations and timings, as if they were being collected by real-world instruments. `VirtualShip` shares some functionality with existing tools, such as `OceanSpy` [@Almansi2019] and `VirtualFleet` [@Maze2023], but extends capabilities to mesh many different instrument deployments into a unified expedition simulation framework. Moreover, `VirtualShip` exploits readily available, streamable data via the Copernicus Marine Data Store, removing the need for users to download and manage large datasets locally and/or arrange for access to remote servers. `VirtualShip` can also integrate coordinate files exported from the [Marine Facilities Planning](https://www.marinefacilitiesplanning.com/cruiselocationplanning#) (MFP) tool, giving users the option to define expedition waypoints via an intuitive web-based mapping interface.
4949

50-
# Functionality
51-
5250
`VirtualShip` simulates the deployment of virtual instruments commonly used in oceanographic fieldwork, with emphasis on realism in how users plan and execute expeditions. For example, users must consider ship speed and instrument deployment/recovery times to ensure their expedition is feasible within given time constraints. Possible instrument selections include surface `Drifter` [@Lumpkin2017], `CTD` (Conductivity-Temperature-Depth; @Johnson2007), `Argo float` [@Jayne2017], `XBT` (Expendable Bathythermograph; @Goni2019), underway `ADCP` (Acoustic Doppler Current Profiler; @Kostaschuk2005), and underway `temperature/salinity` [@Gordon2014] probes. More detail on each instrument is available in the [documentation](https://virtualship.readthedocs.io/en/latest/user-guide/assignments/Research_proposal_intro.html#Measurement-Options).
5351

52+
# Software design
53+
5454
The software can simulate complex multidisciplinary expeditions. One example is a virtual expedition across the Agulhas Current and the South Eastern Atlantic that deploys a suite of instruments to sample physical and biogeochemical properties (\autoref{fig:fig1}). Key circulation features appear early in the expedition track, with enhanced ADCP speeds marking the strong Agulhas Current (\autoref{fig:fig1}b) and drifters that turn back toward the Indian Ocean indicating the Agulhas Retroflection (\autoref{fig:fig1}c). The CTD profiles capture the vertical structure of temperature and oxygen along the route, including the warmer surface waters of the Agulhas region (\autoref{fig:fig1}d, early waypoints) and the Oxygen Minimum Zone in the South Eastern Atlantic (\autoref{fig:fig1}e, final waypoints).
5555

5656
The software is designed to be highly intuitive to the user. It is wrapped into three high-level command line interface commands using [Click](https://click.palletsprojects.com/en/stable/):
@@ -61,22 +61,24 @@ The software is designed to be highly intuitive to the user. It is wrapped into
6161

6262
A full example workflow is outlined in the [Quickstart Guide](https://virtualship.readthedocs.io/en/latest/user-guide/quickstart.html) documentation.
6363

64-
![Example VirtualShip expedition simulated in July/August 2023. Expedition waypoints displayed via the MFP tool (a), Underway ADCP measurements (b), Surface drifter releases (c; 90-day lifetime per drifter), and CTD vertical profiles for temperature (d) and oxygen (e). Black triangles in b), d) and e) mark waypoint locations across the expedition route, corresponding to the purple markers in a).\label{fig:fig1}](figure1.png)
65-
66-
# Implementation
67-
6864
Under the hood, `VirtualShip` is modular and extensible. The workflows are designed around `Instrument` base classes and instrument-specific subclasses and methods. This means the platform can be easily extended to add new instrument types. Instrument behaviours are coded as `Parcels` kernels, which allows for extensive customisability. For example, a `Drifter` advects passively with ocean currents, a `CTD` performs vertical profiling in the water column and an `ArgoFloat` cycles between ascent, descent and drift phases, all whilst sampling physical and/or biogeochemical fields at their respective locations and times.
6965

7066
Moreover, the data ingestion system relies on Analysis-Ready and Cloud-Optimized data (ARCO; @Stern2022, @Abernathey2021) streamed directly from the Copernicus Marine Data Store, via the [`copernicusmarine`](https://github.com/mercator-ocean/copernicus-marine-toolbox) Python toolbox. This means users can simulate expeditions anywhere in the global ocean without downloading large datasets by default. Leveraging the suite of [physics and biogeochemical products](https://virtualship.readthedocs.io/en/latest/user-guide/documentation/copernicus_products.html) available on the Copernicus plaform, expeditions are possible from 1993 to present and forecasted two weeks into the future. There is also an [option](https://virtualship.readthedocs.io/en/latest/user-guide/documentation/pre_download_data.html) for the user to specify local `NetCDF` files for data ingestion, if preferred.
7167

72-
# Applications and future outlook
68+
![Example VirtualShip expedition simulated in July/August 2023. Expedition waypoints displayed via the MFP tool (a), Underway ADCP measurements (b), Surface drifter releases (c; 90-day lifetime per drifter), and CTD vertical profiles for temperature (d) and oxygen (e). Black triangles in b), d) and e) mark waypoint locations across the expedition route, corresponding to the purple markers in a).\label{fig:fig1}](figure1.png)
69+
70+
# Research impact statement
7371

7472
`VirtualShip` has already been extensvely applied in Master's teaching settings at Utrecht University as part of the [VirtualShip Classroom](https://www.uu.nl/en/research/sustainability/sustainable-ocean/education/virtual-ship) initiative. Educational assignments and tutorials have been developed alongside to integrate the tool into coursework, including projects where students design their own research question(s) and execute their fieldwork and analysis using `VirtualShip`. Its application has been shown to be successful, with students reporting increased self-efficacy and knowledge in executing oceanographic fieldwork [@Daniels2025].
7573

7674
The package opens space for many other research applications. It can support real-life expedition planning by letting users test sampling routes before going to sea. It also provides tooling to explore real-time adaptive strategies in which sampling plans shift as forecasts or observations update. The same workflow can also be used to investigate sampling efficiency, for example, examining how waypoint number or spacing shapes the ability to capture features of interest. Moreover, the software is well-suited for developing Observation System Simulation Experiments (OSSEs; e.g. @Errico2013) to test and optimise observational strategies in a cost- and time-efficient manner. This framework further enables instrument design experiments that are relevant to autonomous observing systems. There is potential for users to prototype and test control strategies for gliders, REMUS vehicles, and Saildrones, as well as explore concepts for new instruments at early stages of development. Future tutorials could demonstrate how to define custom instruments within the VirtualShip framework.
7775

7876
Both the customisability of the `VirtualShip` platform and the exciting potential for new ARCO-based data hosting services in domains beyond oceanography (e.g., [atmospheric science](https://climate.copernicus.eu/work-progress-our-data-stores-turn-arco)) means there is potential to extend VirtualShip (or "VirtualShip-like" tools) to other domains in the future. Furthermore, as the `Parcels` underpinnings themselves continue to evolve, with a future (at time of writing) [v4.0 release](https://docs.oceanparcels.org/en/v4-dev/v4/) focusing on alignment with [Pangeo](https://pangeo.io/) standards and `Xarray` data structures [@Hoyer2017], `VirtualShip` will also benefit from these improvements, further enhancing its capabilities, extensibility and compatability with modern cloud-based data pipelines.
7977

78+
# AI usage disclosure
79+
80+
Generative AI technologies (Gemini v2.0/2.5/3.0, ChatGPT v4o/5.0/5.1/5.2 and GitHub Copilot) were used for code generation, refactoring and test scaffolding. AI-assisted autocompletion tools (via GitHub Copilot) were used in the writing of this manuscript. Authors carefully reviewed and edited all AI-assisted content and made the core desigin decisions.
81+
8082
# Acknowledgements
8183

8284
The VirtualShip project is funded through the Utrecht University-NIOZ (Royal Netherlands Institute for Sea Research) collaboration.

docs/paper/paper.pdf

2.57 KB
Binary file not shown.

0 commit comments

Comments
 (0)