tidepods

Extract gridded tide values from MIKE for a given area of interest and create a tidal surface.

NOTE: Please note that the new version MIKE 2021 should be installed, it does not work with the 2016 version.

Installation

1. Setup

1. Download and install Miniconda (Python 3). If you already have Anaconda or Miniconda installed, you can skip this step.

2. Install MIKE Zero and the MIKE SDK /(Mike Core SDK).

3. Install The Mike SDK Tide Constituents, the dowloaded file needs to be placed in the Tide_Constituents folder. Default being C:\Program Files (x86)\DHI\MIKE Zero\2021\Application Data\Tide_Constituents

4. This version of tidepods has been tested and works with the 2021 versions of MIKE. Default install directory is:

   C:\Program Files (x86)\DHI\2021
   

5. Ensure MIKE Zero and the MIKE SDK are installed. Tidepods relies on certain files within these directories, thus the installation directory tree needs to be consistent. Default installation locations are:

   C:\Program Files (x86)\DHI\Mike SDK\2021
   C:\Program Files (x86)\DHI\Mike Zero\2021
   

6. Make sure the MIKE applications have access to a valid license.

7. Add the root MIKE installation directory to the environment variables, naming it "MIKE" e.g.:

   Variable: MIKE
   Value: C:\Program Files (x86)\DHI
   

8. Rename the folder "C:\Program Files (x86)\DHI\Mike Core SDK\2021" --> "C:\Program Files (x86)\DHI\Mike SDK\2021"

9. If you get an error: "TypeError: expected str, bytes or os.PathLike object, not NoneType" , try to activate env (activate tidepods) and set up the path:

set MIKE=C:\Program Files (x86)\DHI

2. The tidepods environment

1. Download the most recent environment.yml file (right-click, save-as) and run:

   conda env create -f /path/to/environment.yml
   

   This creates the tidepods environment

Usage

After installation, the tidepods environment will contain the tidepods command-line interface.

1. Activate the tidepods environment

activate tidepods

2. Get information about the tidepods CLI with:

tidepods --help

Usage: tidepods [OPTIONS] COMMAND [ARGS]...

  Tidal Surface Processing Tasks.

Options:
  --help  Show this message and exit.

Commands:
  icesat2  Extract tide levels at icesat_2 acquisition points.
  s2       Create a tidal surface for a Sentinel 2 acquisition.
  vhr      Create a point shp containing tide values over AOI (VHR image).

Individual Commands

The individual commands available within tidepods are: icesat2, s2, vhr e.g.

tidepods icesat2 --help

Usage: tidepods icesat2 [OPTIONS]

  Extract tide levels at icesat_2 acquisition points.

  Example use:

  tidepods icesat2 -s C:/tides/processed_icesat_pts.shp -o C:/tides_output
  -l MSL

Options:
  -s, --shapefile FILE       Path to input shapefile e.g.
                             C:/tides/processed_icesat_pts.shp  [required]

  -o, --outfolder DIRECTORY  Path to output folder where tidepods will create
                             the updated shapefile e.g. C:/tides  [required]

  -l, --level [LAT|MSL]      Tide value return type, LAT (Lowest Astronomical
                             Tide) or MSL (Mean Sea Level)  [required]

  --help                     Show this message and exit.

Examples: • Sentinel-2 images

(tidepods) C:\Users>tidepods s2 -s M:/SDBd/S2A_MSIL1C_20210801T221941_N0301_R029_T60KXE_20210801T233745.SAFE -l MSL -o //dkcph1-ncr2421/ICESat2/tidepods_MSL

• icesat2

(tidepods) C:\Users>tidepods icesat2 -s C:/Users/ansu/Desktop/tidepods-ansu/tidepods_A.shp -l LAT -o C:/Users/ansu/Desktop/tidepods-ansu