|
4 | 4 | "cell_type": "markdown", |
5 | 5 | "metadata": {}, |
6 | 6 | "source": [ |
7 | | - "### Time has come to start your expedition!\n", |
| 7 | + "### Start your expedition!\n", |
8 | 8 | "\n", |
9 | 9 | "https://www.youtube.com/watch?v=G82kIgc1imk\n", |
10 | 10 | "\n", |
|
15 | 15 | "cell_type": "markdown", |
16 | 16 | "metadata": {}, |
17 | 17 | "source": [ |
18 | | - "Create a folder for your expedition where the results will be saved. Initialize the virtualship using a `!` to use the tool directly from this notebook or copy the commands (without the `!`) directly into your terminal\n", |
19 | | - "```\n", |
20 | | - "Usage: virtualship init [OPTIONS] PATH\n", |
| 18 | + "On your (virtual) machine change directory into the folder where your expedition will be run. Initialize the virtualship by copying the commands directly into a terminal.\n", |
21 | 19 | "\n", |
22 | | - " Initialize a directory for a new expedition, with an example schedule and\n", |
23 | | - " ship config files.\n", |
24 | | - " ```" |
25 | | - ] |
26 | | - }, |
27 | | - { |
28 | | - "cell_type": "code", |
29 | | - "execution_count": null, |
30 | | - "metadata": {}, |
31 | | - "outputs": [], |
32 | | - "source": [ |
33 | | - "!virtualship init EXPEDITION_NAME" |
| 20 | + ">Usage: virtualship init [OPTIONS] PATH\n", |
| 21 | + ">\n", |
| 22 | + "> Initialize a directory for a new expedition, with an example schedule and\n", |
| 23 | + "> ship config files.\n", |
| 24 | + "\n", |
| 25 | + "```virtualship init EXPEDITION_NAME```" |
34 | 26 | ] |
35 | 27 | }, |
36 | 28 | { |
|
39 | 31 | "source": [ |
40 | 32 | "This will create a folder `EXPEDITION_NAME` with two files: `schedule.yaml` and\t`ship_config.yaml`.\n", |
41 | 33 | "\n", |
42 | | - "Populate the `schedule.yaml` file manually with each sampling CTD station and drifer/argo float deployment position. The route between points will be sailed as the shortest great-cirlce distance. \n", |
43 | | - "[TODO: or initialize from a MFP csv file and correct where needed]\n", |
44 | | - "\n", |
45 | | - "When you have finished your schedule, run the fetch command to download input data for the virtual ship from the Copernicus marine data store. \n", |
46 | | - "You will need to register via: https://data.marine.copernicus.eu/register and provide your username and password as command line arguments:\n", |
47 | | - "```\n", |
48 | | - "Usage: virtualship fetch [OPTIONS] PATH\n", |
| 34 | + "You can populate the `schedule.yaml` file manually with each sampling CTD station and XBT/DRIFTER/ARGO_FLOAT deployment position. Or use the exported cruise coordinates from MFP. In that case, add an extra column to the .xlsx file called `Instrument` and on each line write which instruments you want to use or deploy there. Multiple instrument are allowed, e.g. `DRIFTER, CTD` or `DRIFTER, ARGO_FLOAT`. If you want to use your MFP export, make sure your directory is clean and run:\n", |
49 | 35 | "\n", |
50 | | - " Download input data for an expedition.\n", |
51 | | - " ```" |
52 | | - ] |
53 | | - }, |
54 | | - { |
55 | | - "cell_type": "code", |
56 | | - "execution_count": null, |
57 | | - "metadata": {}, |
58 | | - "outputs": [], |
59 | | - "source": [ |
60 | | - "!virtualship fetch EXPEDITION_NAME --username <USERNAME> --password <PASSWORD>" |
| 36 | + "```virtualship init EXPEDITION_NAME --from-mfp CoordinatesExport.xlsx```" |
61 | 37 | ] |
62 | 38 | }, |
63 | 39 | { |
64 | 40 | "cell_type": "markdown", |
65 | 41 | "metadata": {}, |
66 | 42 | "source": [ |
67 | | - "After your input data has been downloaded you can begin your expedition:\n", |
68 | | - "```\n", |
69 | | - "Usage: virtualship run [OPTIONS] PATH\n", |
70 | 43 | "\n", |
71 | | - " Run the expedition.\n", |
72 | | - " ```" |
| 44 | + "Mind that the route between points will be sailed as the shortest great-cirlce distance. \n", |
| 45 | + "\n", |
| 46 | + "Instrument configurations can be provided in `ship_config`. \n", |
| 47 | + "\n", |
| 48 | + "Under `adcp_config` provide the configuration of your ADCP, so either `max_depth_meter: -1000.0` if you want to use the OceanObserver or `max_depth_meter: -150.0` if you want to use the SeaSeven. \n", |
| 49 | + "\n", |
| 50 | + "If you don't need the ADCP to measure, remove the `adcp_config` and underlying lines from the configuration file. \n", |
| 51 | + "\n", |
| 52 | + "If you do not want to collect underway data, remove `ship_underwater_st_config` from the configuration file.\n", |
| 53 | + "\n", |
| 54 | + "Change the xbt, drifter and argo_float configurations if you want.\n", |
| 55 | + "\n", |
| 56 | + "For the CTD, provide the maximum depth you will want to measure at. All other CTD casts will be done to approximately 20 meter of the ocean floor. \n", |
| 57 | + "\n", |
| 58 | + "When you have finished your schedule and config, run the fetch command to download input data for the virtual ship from the Copernicus marine data store. \n", |
| 59 | + "You will need to register via: https://data.marine.copernicus.eu/register \n", |
| 60 | + "You can provide your username and password as command line arguments. If you don't you will be prompted for your credentials.\n", |
| 61 | + "\n", |
| 62 | + "> Usage: virtualship fetch [OPTIONS] PATH\n", |
| 63 | + ">\n", |
| 64 | + "> Download input data for an expedition.\n", |
| 65 | + "\n", |
| 66 | + "```virtualship fetch EXPEDITION_NAME --username <USERNAME> --password <PASSWORD>```\n", |
| 67 | + "\n", |
| 68 | + "```virtualship fetch EXPEDITION_NAME```" |
73 | 69 | ] |
74 | 70 | }, |
75 | 71 | { |
76 | | - "cell_type": "code", |
77 | | - "execution_count": null, |
| 72 | + "cell_type": "markdown", |
78 | 73 | "metadata": {}, |
79 | | - "outputs": [], |
80 | 74 | "source": [ |
81 | | - "!virtualship run EXPEDITION_NAME" |
| 75 | + "Waiting for your data download is a great time to practice your level of patience. A skill much needed in oceanographic fieldwork ;-)\n", |
| 76 | + "\n", |
| 77 | + "After your input data has been downloaded you can do your expedition:\n", |
| 78 | + "\n", |
| 79 | + "> Usage: virtualship run [OPTIONS] PATH\n", |
| 80 | + ">\n", |
| 81 | + "> Run the expedition.\n", |
| 82 | + "\n", |
| 83 | + "```virtualship run EXPEDITION_NAME```" |
82 | 84 | ] |
83 | 85 | }, |
84 | 86 | { |
|
0 commit comments