diff --git a/README.md b/README.md index 8ab705e..c0fe1cb 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ The Python code here is discussed, referenced, and used to produce figures in Ap This code was written using Python 3.7.3. -Steps to use this code to reproduce Appendix A "Repurposing ADCP data: A case study on Tropical Pacific mid-trophic level prey" figures are as follows: +Steps to use this code to reproduce Appendix A "Repurposing ADCP data: A case study on Tropical Pacific mid-trophic level prey" figures are as follows: 1. Download the python folder or clone this repo. 2. Obtain all desired JASADCP (Joint Archive for Shipboard Acoustic Doppler Current Profiler) netcdf files as described in Appendix A from https://uhslc.soest.hawaii.edu/sadcp/. Put these ncfiles into a folder called JASADCP. 3. Build a docker container with all the required python packages using Dockerfile inside the docker dir. (Or create a virtual environment with the packages listed in the Dockerfile.) @@ -14,4 +14,4 @@ These steps/code provide a starting framework for how you can use this amazing J To properly employ this code, however, each individual user should begin by verifying that it is working how they expect. Each individual user is also responsible for calculating the errors caused by any assumptions made in the code for their individual dataset and purpose. -6/24/20: To see the latest developments to this code base, head to the develop branch, which currently has (preliminary) code to calculate S_v from time and depth-resolved temperature and salinity profiles. +6/24/20: To see the latest developments to this code base, head to the develop branch, which currently has (preliminary) code to calculate <i>S<sub>v</sub></i> from time and depth-resolved temperature and salinity profiles.