Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
136 commits
Select commit Hold shift + click to select a range
edbda0b
add info on sensor configuration
j-atkins May 20, 2026
cd5b523
add list of available sensors to documentation
j-atkins May 20, 2026
4668e54
remove redundant TODO
j-atkins May 20, 2026
ae2d528
improve phrasing
j-atkins May 20, 2026
17d5b40
add details on sensor configurations to quickstart guide
j-atkins May 20, 2026
baa982a
update sail_the_ship with sensor configuration instructions
j-atkins May 20, 2026
a8a4978
enahnce phrasing
j-atkins May 20, 2026
6b3628e
add testing that docs match the code for sensor options, ensure instr…
j-atkins May 20, 2026
e23087b
add check that all instruments in code are addressed in sensor table
j-atkins May 20, 2026
a5ff3a4
update environments to pull parcels v4 alpha
j-atkins May 20, 2026
db44324
changed parcels logging api
j-atkins May 20, 2026
6f732d3
first wave of changes to the instrument logic with v4 logic, and part…
j-atkins May 20, 2026
71881cc
remove add dummy UV func, shouldn't be needed in v4 (?)
j-atkins May 20, 2026
62b2b1b
pull v4 from parcels/main
j-atkins May 20, 2026
38afc56
use AdvectionRK2
j-atkins May 20, 2026
573da9e
migrate fieldset ingestion protocol
j-atkins May 20, 2026
d13a036
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] May 20, 2026
5c7fd29
standardise variable naming for bathy data ingestion
j-atkins May 21, 2026
ee17230
env fixes
j-atkins May 21, 2026
72161df
Merge branch 'main' into migrate-v4
j-atkins May 21, 2026
92e74bd
add ipdb for devs
j-atkins May 21, 2026
0a83437
further changes to suit v4
j-atkins May 21, 2026
ca9e306
first steps considering handling depth positive up or down
j-atkins May 22, 2026
d4093cf
Merge branch 'migrate-v4' of github.com:OceanParcels/virtualship into…
j-atkins May 22, 2026
63122b9
refactor to _compute_max_depths; more changes in line with Parcels v4…
j-atkins May 26, 2026
a6ad631
depth -> z in ParticleSet's
j-atkins May 26, 2026
8e0a33f
times to datetime64 and update fieldset eval output
j-atkins May 28, 2026
8b76854
tmp ds.load() step for v4.0
j-atkins May 29, 2026
27c36e2
Merge branch 'main' into migrate-v4
j-atkins Jun 5, 2026
81f857f
error messaging in argo floats
j-atkins Jun 5, 2026
cd2f9ff
refactor _generate_fieldset()
j-atkins Jun 5, 2026
39e63d1
small tidy up
j-atkins Jun 5, 2026
0dc5975
from zarr -> parquet output
j-atkins Jun 5, 2026
3e52b10
endtime/time_origin API update
j-atkins Jun 5, 2026
07209bf
no temp sampling in phase 3
j-atkins Jun 5, 2026
9cb321c
endtimes access scalars directly
j-atkins Jun 5, 2026
137978d
fix wrong var name in kernel
j-atkins Jun 5, 2026
c29efe6
combined vector fields for instruments
j-atkins Jun 5, 2026
a8242c1
small tweaks/fixes
j-atkins Jun 5, 2026
95d84b7
cmo to pixi.toml and tweaked particleset API
j-atkins Jun 5, 2026
7f68c83
depth -> z for argo sampling, update interp method in base, fix ctd v…
j-atkins Jun 10, 2026
003f79f
move to positive down API throughout virtualship
j-atkins Jun 10, 2026
da86613
Revert "move to positive down API throughout virtualship"
j-atkins Jun 11, 2026
a468ade
negate *and* reindex depth in ds before fieldset creation
j-atkins Jun 11, 2026
fd2232a
fill land/nans with 0s
j-atkins Jun 11, 2026
0be180d
fixes to argo kernels + some refactoring
j-atkins Jun 12, 2026
c5b8378
Merge branch 'main' into migrate-v4
j-atkins Jun 16, 2026
1faf09d
Merge branch 'main' into migrate-v4
j-atkins Jul 13, 2026
c05d2f7
switch to using .to_windowed_arrays() for performance
j-atkins Jul 13, 2026
cff0240
neater way of negating depth
j-atkins Jul 13, 2026
d9df5b6
use interpolator object
j-atkins Jul 13, 2026
f89ce73
lat/lon/time -> y/x/t
j-atkins Jul 14, 2026
d8bd074
performance step: windowed arrays
j-atkins Jul 14, 2026
ca3ba1f
time -> t
j-atkins Jul 14, 2026
c740630
fix argo bug, min_depth spec to avoid immediately error out of bounds
j-atkins Jul 16, 2026
abb5380
remove ds.load/to_windowed_arrays experiments
j-atkins Jul 17, 2026
583fc7b
lon -> x
j-atkins Jul 20, 2026
f2becc0
use vertical_axis arg for depth convention
j-atkins Jul 20, 2026
ae98059
Refactor dataset retrieval specs (#359)
j-atkins Jul 22, 2026
391b930
add tmp file write/read step (#358)
j-atkins Jul 23, 2026
1ca6860
`to_windowed_arrays` only for non-underway instruments (#361)
j-atkins Jul 27, 2026
4dfa96f
Update underway (#360)
j-atkins Jul 31, 2026
ebd2c0c
Add initial Field sampling for non-underway instruments (#364)
j-atkins Aug 3, 2026
ac43f15
remove .fillna() now that it's in Parcels internals
j-atkins Aug 3, 2026
1e08b96
via_tmp_ds is only needed when streaming data
j-atkins Aug 4, 2026
c202418
FetchSpec takes the VirtualShip-native negative depth values
j-atkins Aug 4, 2026
9057312
bring --from-data methods up to date with new v4 workflows, also incl…
j-atkins Aug 4, 2026
d68aa09
update test_utils for new v4 workflows
j-atkins Aug 4, 2026
707328d
update test_expedition for v4 fieldset ingestion
j-atkins Aug 4, 2026
56bf4df
use context managers for _via_tmp_ds, fix using abs() for copernicusm…
j-atkins Aug 4, 2026
8954456
avoid annoying warnings concerning potential pixi build issues and co…
j-atkins Aug 4, 2026
acca7e3
revert need to specify h5netcdf engine
j-atkins Aug 4, 2026
fefcc20
update test_base.py for new v4 workflows
j-atkins Aug 4, 2026
de8c627
update tests for v4 workflows and enhance out of bounds error checking
j-atkins Aug 5, 2026
f17b43e
update tests for v4 workflows
j-atkins Aug 5, 2026
52ff1fd
update drifter tests for v4 workflows
j-atkins Aug 5, 2026
90bef40
fix bugs in xbt behavious, also update particleset inspection for v4
j-atkins Aug 5, 2026
12d87f6
update xbt tests for v4 workflows
j-atkins Aug 5, 2026
4e075a2
attempt to fix pixi env and CI
j-atkins Aug 5, 2026
dc783c0
update pixi and CI to python 3.14
j-atkins Aug 6, 2026
1d3955a
update contribution guide for pixi instructions
j-atkins Aug 6, 2026
616f5d8
fix pre-commit issue
j-atkins Aug 6, 2026
9a53435
sort out encoding to avoid UserWarnings
j-atkins Aug 6, 2026
f37ce1d
use fieldset.time_interval.left notation
j-atkins Aug 6, 2026
b3fe2de
add _handle_grounding test
j-atkins Aug 6, 2026
9601783
Merge branch 'main' into migrate-v4
j-atkins Aug 6, 2026
84db2eb
remove docstring for consistency
j-atkins Aug 7, 2026
fb789fc
filter out parcels v4 user warning for (temporary measure)
j-atkins Aug 7, 2026
d95cc5e
Merge branch 'migrate-v4' of github.com:OceanParcels/virtualship into…
j-atkins Aug 7, 2026
495c143
remove initial sampling from argo floats
j-atkins Aug 10, 2026
26d6681
argo kernel: solve issue of not updating cycle_age during ascent
j-atkins Aug 10, 2026
e40defd
Update docs for v4 migration (#371)
j-atkins Aug 12, 2026
d047bb4
make train the teacher section
j-atkins Aug 21, 2026
00c215f
new page for surf specific set up
j-atkins Aug 21, 2026
9b7eed1
screenshots for surf set up
j-atkins Aug 21, 2026
533856f
additions to surf guide
j-atkins Aug 21, 2026
431ca68
more information on file permissions on surf
j-atkins Aug 21, 2026
6ca09f4
more information on tailored support
j-atkins Aug 21, 2026
e5f779c
further additions; including new documents for lesson plans and stude…
j-atkins Aug 21, 2026
550cfc0
more content to train the teacher; update the sail the ship instructi…
j-atkins Aug 21, 2026
30ed5f6
batch of updates to the train the teacher guide and associated docs
j-atkins Aug 24, 2026
912ea6a
update user guide: reorganise to user profiles; add warning that this…
j-atkins Aug 24, 2026
2751ea6
init new directories for user profiles
j-atkins Aug 24, 2026
ed80f38
reorganise dir structure
j-atkins Aug 24, 2026
78c0816
reorganise the educator dir
j-atkins Aug 24, 2026
751797d
reorganise docs: replace teacher-content with educators
j-atkins Aug 24, 2026
0457317
further reorganisation of docs
j-atkins Aug 26, 2026
bfaebcd
overhaul teach the trainer: use github codespaces and binder
j-atkins Aug 27, 2026
1fb2f10
tmp docs preview workflow
j-atkins Aug 28, 2026
7387c82
update workflow commit pointer
j-atkins Aug 28, 2026
d628581
attempt new fix
j-atkins Aug 28, 2026
ba67b81
remove preview docs support
j-atkins Aug 28, 2026
4b7ab87
further updates to new workspaces workflow
j-atkins Aug 28, 2026
4281a3b
edit text
j-atkins Aug 28, 2026
f756262
edits to instructions
j-atkins Aug 28, 2026
694f4f6
use more powerful codespace for argo floats and tips for reducing mem…
j-atkins Sep 3, 2026
c5c8912
revert to using days for default lifetime
j-atkins Sep 4, 2026
30d025c
Merge branch 'main' into docs-reorganise
j-atkins Sep 15, 2026
43b5505
revert wrong merge conflict resolutions
j-atkins Sep 15, 2026
dd93081
add sphinx-design
j-atkins Sep 15, 2026
510b066
add more generalised note on codespaces performance considerations
j-atkins Sep 16, 2026
78990b3
updated guidance on performance constraints
j-atkins Sep 16, 2026
20c94e7
placeholders in other user-profile tabs
j-atkins Sep 16, 2026
992e825
further populate researchers tab
j-atkins Sep 17, 2026
3d6a293
remove outdated todo
j-atkins Sep 18, 2026
e80e854
link to Copernicus
j-atkins Sep 18, 2026
2be1737
remind that using more powerful machine comes at hours cost
j-atkins Sep 18, 2026
2e3ae58
link to actual Binder environment
j-atkins Sep 18, 2026
6832f1d
link to Parcels hosted workspace repo
j-atkins Sep 18, 2026
7a42793
add links to guides on how to use MFP
j-atkins Sep 18, 2026
1c94a5f
add todo
j-atkins Sep 18, 2026
224d3fb
remove/more generalised reference to hours quotas
j-atkins Sep 21, 2026
73f7082
Merge branch 'main' into docs-reorganise
j-atkins Sep 21, 2026
2ff85f5
reinstate accidentally deleted dep
j-atkins Sep 21, 2026
077aa2b
migrate port-relevant changes over to sail_the_ship
j-atkins Sep 21, 2026
3c01671
clean up docs
j-atkins Sep 21, 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
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,15 +87,23 @@ Usage: virtualship init [OPTIONS] PATH

Initialize a directory for a new expedition, with an expedition.yaml file.

If --mfp-file is provided, it will generate the expedition.yaml from the MPF
file instead.
If --mfp-file is provided (and --start-date is also provided), it will
generate the expedition.yaml from the MPF file instead.

Options:
--from-mfp TEXT Partially initialise a project from an exported xlsx or csv
file from NIOZ' Marine Facilities Planning tool
(specifically the "Export Coordinates > DD" option). User
edits are required after initialisation.
--help Show this message and exit.
--from-mfp TEXT Initialise a project from an exported xlsx
file from NIOZ' Marine Facilities Planning
tool (specifically the "Export Cruise Data"
option). User edits may be required after
initialisation.
--start-date [%Y-%m-%d %H:%M:%S|%Y-%m-%d]
The departure/start date of the expedition
(required when using --from-mfp). Expected
format: 'YYYY-MM-DD HH:MM:SS' (with quotes,
e.g., '2023-10-20 01:00:00'). If only the
date is provided, the time will default to
00:00:00.
--help Show this message and exit.
```

```console
Expand Down
11 changes: 8 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
"sphinx.ext.napoleon",
# "sphinx_autodoc_typehints",# https://github.com/Parcels-code/virtualship/pull/125#issuecomment-2668766302
"sphinx_copybutton",
"sphinx_design",
]

source_suffix = [".rst", ".md"]
Expand Down Expand Up @@ -44,6 +45,7 @@
"type": "fontawesome",
}
],
"announcement": "<strong>Warning</strong>: this is a pre-release version of the VirtualShip documentation (V1 to be released in September/October 2026). The contents are subject to change and may not be complete.",
}
html_context = {
"github_user": "Parcels-code",
Expand All @@ -70,20 +72,23 @@
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",
"user-guide/teacher-content/UU-ocean-of-future/Tutorial2": "user-guide/_images/freepik_assignment.png",
"user-guide/tutorials/surf_collaborative_setup": "user-guide/_images/freepik_research_vessel.jpg",
"user-guide/tutorials/surf_research_cloud_setup": "user-guide/_images/freepik_research_vessel.jpg",
"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/tutorials/codespaces_guide": "user-guide/_images/AnnaWeber.jpeg",
"user-guide/tutorials/binder_guide": "user-guide/_images/AnnaWeber.jpeg",
"user-guide/user-profiles/educators/letter": "user-guide/_images/freepik_research_vessel.jpg",
}

sphinx_gallery_conf = {"default_thumb_file": "_static/virtual_ship_logo.png"}
Expand Down
Loading
Loading