Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,33 +22,33 @@
<table>
<tr>
<th>Project Owner</th>
<td>Emma Daniels (e.e.daniels1@uu.nl)</td>
<td>VirtualShip Team (virtualship@uu.nl)</td>
</tr>
<tr>
<!-- Should mirror pyproject.toml. Use one of the "Development status" flags from https://pypi.org/classifiers/-->
<th>Development status</th>
<td>Alpha</td>
<td>Beta</td>
</tr>
</table>

<!-- TODO: README needs updating for v1-dev! -->

<!-- Insert catchy summary -->

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
Expand All @@ -57,11 +57,12 @@ 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

> [!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`.
Expand Down Expand Up @@ -137,7 +138,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

Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 = [
Expand Down
Loading