diff --git a/README.md b/README.md index ddf444d4..c66ab2fc 100644 --- a/README.md +++ b/README.md @@ -22,12 +22,12 @@ - + - +
Project OwnerEmma Daniels (e.e.daniels1@uu.nl)VirtualShip Team (virtualship@uu.nl)
Development statusAlphaBeta
@@ -35,20 +35,20 @@ -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 @@ -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`. @@ -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 diff --git a/docs/conf.py b/docs/conf.py index c93f3c5e..6fb9916e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 = [