virtualship 0.0.3.dev44

Code for the Virtual Ship Classroom, where Marine Scientists can combine Copernicus Marine Data with an OceanParcels ship to go on a virtual expedition.

---

Project Owner	Emma Daniels ([e-mail])
Development status	Alpha

VirtualShipParcels 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:

• ADCP (for currents)
• CTD (for conductivity, and temperature)
• underwater measurements (salinity and temperature)
• surface drifters
• argo float deployments

Installation

For a normal installation do:

conda create -n my_env python=3.12
conda activate my_env
conda install -c conda-forge virtualship

For a development installation, please follow the instructions detailed in the contributing page.

Usage

$ virtualship --help
Usage: virtualship [OPTIONS] COMMAND [ARGS]...

Options:
  --version  Show the version and exit.
  --help  Show this message and exit.

Commands:
  fetch  Download the relevant data specified in an expedition directory...
  init   Initialize a directory for a new expedition, with an example...
  run    Do the expedition.

$ virtualship init --help
Usage: virtualship init [OPTIONS] PATH

  Initialize a directory for a new expedition, with an example configuration.

Options:
  --help  Show this message and exit.

$ virtualship fetch --help
Usage: virtualship fetch [OPTIONS] PATH

  Download the relevant data specified in an expedition directory (i.e., by
  the expedition config).

Options:
  --help  Show this message and exit.

$ virtualship run --help
Usage: virtualship run [OPTIONS] PATH

  Do the expedition.

Options:
  --help  Show this message and exit.

For examples, see LINK_TO_TURORIALS.

Input data

The scripts are written to work with A-grid ocean data from CMEMS.