proof reading changes

Author: j-atkins

docs/user-guide/tutorials/ADCP_transects.ipynb

@@ -9,7 +9,7 @@
     "\n",
     "This notebook demonstrates a simple plotting exercise for ADCP data across a transect, using the output of a VirtualShip expedition. There are example plots embedded at the end, but these will ultimately be replaced by your own versions as you work through the notebook.\n",
     "\n",
-    "The plot(s) we will produce are simple plots which follow the trajectory of the expedition as a function of distance from the start, and are intended to be a starting point for your analysis. Because the `ADCP` instrument is an underway/onboard instrument, this means we benefit from continous recordings across the length of the ship's track (unlike overboard instruments such as CTDs which have to deployed at individual sampling sites).\n",
+    "The plot(s) we will produce are simple plots which follow the trajectory of the expedition as a function of distance from the start, and are intended to be a starting point for your analysis. Because the `ADCP` instrument is an underway/onboard instrument, this means we benefit from continuous recordings across the length of the ship's track (unlike overboard instruments such as CTDs which have to deployed at individual sampling sites).\n",
     "\n",
     "<div class=\"alert alert-block alert-info\"> \n",
     "<b>NOTE:</b> This notebook assumes that each point along the expedition track is further from the start than the previous point. The code will still work if not, but the resultant plots might not be very intuitive.\n",
@@ -23,6 +23,8 @@
    "source": [
     "## Set up\n",
     "\n",
+    "#### Imports\n",
+    "\n",
     "The first step is to import the Python packages required for post-processing the data and plotting. "
    ]
   },
@@ -46,6 +48,9 @@
    "id": "360f84ce",
    "metadata": {},
    "source": [
+    "\n",
+    "#### Data directory\n",
+    "\n",
     "Next, you should set `data_dir` to be the path to your expedition results in the code block below. You should replace `\"/path/to/EXPEDITION/results/\"` with the path for your machine.\n",
     "\n",
     "<div class=\"alert alert-block alert-success\"> \n",
@@ -55,13 +60,12 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 7,
    "id": "0cb630f6",
    "metadata": {},
    "outputs": [],
    "source": [
-    "data_dir = \"/path/to/EXPEDITION/results/\"  # set this to be where your expedition output data is located on your (virtual) machine\n",
-    "data_dir = \"/Users/Atkin004/Documents/test_expeditions/sept_course/NORTH/results/\""
+    "data_dir = \"/path/to/EXPEDITION/results/\"  # set this to be where your expedition output data is located on your (virtual) machine"
    ]
   },
   {
@@ -148,6 +152,7 @@
    "id": "88062e97",
    "metadata": {},
    "source": [
+    "\n",
     "Now we will execute the various post-processing calculations, plus define some extra useful arrays to be used for the plotting..."
    ]
   },
@@ -287,7 +292,7 @@
    "id": "f2ada2b1",
    "metadata": {},
    "source": [
-    "The resultant figure shows three components of velocity recorded by the ADCP instrument.\n",
+    "The resultant figure shows various components of the velocity field, derived from ADCP data.\n",
     "\n",
     "1) Absolute velocity\n",
     "2) Along-track velocity (where positive values indicate flow in the direction of the ship's track across the the transect)\n",

docs/user-guide/tutorials/CTD_transects.ipynb

@@ -14,7 +14,7 @@
     "The plot(s) we will produce are simple plots which follow the trajectory of the expedition as a function of distance from the first waypoint, and are intended to be a starting point for your analysis. \n",
     "\n",
     "<div class=\"alert alert-block alert-info\"> \n",
-    "<b>NOTE:</b> This notebook assumes that each waypoint in the expedition is further from the start than the last waypoint. The code will still work if not, but the resultant plots might not be very intuitive.\n",
+    "<b>Note:</b> This notebook assumes that each waypoint in the expedition is further from the start than the last waypoint. The code will still work if not, but the resultant plots might not be very intuitive.\n",
     "</div>"
    ]
   },
@@ -25,6 +25,8 @@
    "source": [
     "## Set up\n",
     "\n",
+    "#### Imports\n",
+    "\n",
     "The first step is to import the Python packages required for post-processing the data and plotting. "
    ]
   },
@@ -48,6 +50,9 @@
    "id": "4f387780",
    "metadata": {},
    "source": [
+    "\n",
+    "#### Data directory\n",
+    "\n",
     "Next, you should set `data_dir` to be the path to your expedition results in the code block below. You should replace `\"/path/to/EXPEDITION/results/\"` with the path for your machine.\n",
     "\n",
     "<div class=\"alert alert-block alert-success\"> \n",
@@ -70,6 +75,8 @@
    "id": "a499ebe2",
    "metadata": {},
    "source": [
+    "#### Variable choice\n",
+    "\n",
     "You should now consider which variable from your CTD casts you would like to plot. Which ones are available to you will depend on whether you have used the `CTD` (physical variables) or `CTD_BGC` (biogeochemical) instrument, or both. Below is a list of all valid variable choices for both instruments...\n",
     "\n",
     "`CTD` (physical):\n",
@@ -104,7 +111,8 @@
    "id": "a05fad14",
    "metadata": {},
    "source": [
-    "We also define the `VARIABLES` dictionary here, which we use to store some parameters for the plots (e.g. variable labels, what units each is in, and which colour map we should use for the plots).\n",
+    "\n",
+    "We also define the `VARIABLES` dictionary here, which we use to store some parameters for the plots related to each variable choice (e.g. labels, what units each is in, and which colour map we should use for the plots).\n",
     "\n",
     "<div class=\"alert alert-block alert-success\"> \n",
     "<b>Tip:</b> You don't need to change anything here, but should you wish to change the colour scheme (`cmap`) for any CTD variable you can do so. At the moment it's set to use relevant cmaps from the cmocean Python package, which has developed specialist colour schemes for oceanographic data applications.\n",
@@ -306,6 +314,7 @@
    "id": "2bdf98e6",
    "metadata": {},
    "source": [
+    "\n",
     "Now we will execute the utility functions, plus define some extra useful arrays to be used for the plotting..."
    ]
   },
@@ -409,7 +418,7 @@
     "We can also also plot a 'filled' version without the distance bins, to give an alternative view of the evolution across the transect which is not dominated by gaps and white space. This time we will also add a 'sea bed' to the plot.\n",
     "\n",
     "<div class=\"alert alert-block alert-info\"> \n",
-    "<b>NOTE:</b> It is important to always remember that the gaps do actually exist in reality and this is a caveat which must be considered when interpreting the transect derived from CTD casts. Indeed, if you look at the x-axis of the plot below you will see that the deployments are not necessarily regularly spaced and some gaps are larger than others.\n",
+    "<b>Note:</b> It is important to remember that the gaps do actually exist in reality and this is a caveat which must be considered when interpreting the transect derived from CTD casts. Indeed, if you look at the x-axis of the plot below you will see that the deployments are not necessarily regularly spaced and some gaps are larger than others.\n",
     "</div>"
    ]
   },
@@ -460,14 +469,6 @@
     "plt.colorbar(mesh, ax=ax, label=VARIABLES[plot_variable][\"label\"])\n",
     "plt.tight_layout()"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "97e62cec",
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {