virtualship 0.1.0

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 (currents)
• CTD (conductivity and temperature)
• XBT (temperature)
• underwater measurements (salinity and temperature)
• surface drifters
• argo float deployments

Installation

For a normal installation do:

conda create -n ship -c conda-forge virtualship
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.

Usage

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

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

Commands:
  fetch  Download input data for an expedition.
  init   Initialize a directory for a new expedition, with an example...
  run    Run the expedition.

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

  Initialize a directory for a new expedition, with an example schedule and
  ship config files.

Options:
  --help  Show this message and exit.

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

  Download input data for an expedition.

  Entrypoint for the tool to download data based on space-time region provided
  in the schedule file. Data is downloaded from Copernicus Marine, credentials
  for which can be obtained via registration:
  https://data.marine.copernicus.eu/register . Credentials can be provided on
  prompt, via command line arguments, or via a YAML config file. Run
  `virtualship fetch` on a expedition for more info.

Options:
  --username TEXT  Copernicus Marine username.
  --password TEXT  Copernicus Marine password.
  --help           Show this message and exit.

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

  Run the expedition.

Options:
  --help  Show this message and exit.

For examples, see the tutorials section of our documentation.

Input data

The scripts are written to work with A-grid ocean data from the Copernicus Marine Service.

Source code

The code for this project is hosted on GitHub.

Contributors

All contributions are welcome! See the contributing page in our documentation to see how to get involved. Image made with contrib.rocks.