McGill-sea-ice / ice-tracker-deformations

This project aims at computing arctic sea ice deformations from icetracker data (Sentinel-1 and RCM).
3 stars 3 forks source link

Deformations From Sea Ice Tracker Data

Overview

This project aims at computing arctic sea-ice deformations from icetracker data (Sentinel-1 and RCM). Two distinct methods can be used to compute sea-ice deformations.

Method M01

In this method, data points with X/Y coordinates are processed. After performing a Delaunay triangulation, we compute sea-ice deformations following Bouchat et al. (2020).

Installation

Start by cloning the repository:

# Check if your SSH key is configured on GitHub
ssh -T git@github.com
# Clone the project
git clone git@github.com:McGill-sea-ice/ice-tracker-deformations.git

This project uses a conda environment. Start by accessing the project folder:

cd ice-tracker-deformations

Create and activate the project's environment (this installs the dependencies):

conda env create -f environment.yaml
conda activate icetrackdefs

Install the Cartopy shapefiles (this would be done automatically by Cartopy, but the URL hardcoded in the Cartopy version we used to require is out of service):

conda activate icetrackdefs
wget -q https://raw.githubusercontent.com/SciTools/cartopy/master/tools/cartopy_feature_download.py -O $CONDA_PREFIX/bin/cartopy_feature_download.py
python $CONDA_PREFIX/bin/cartopy_feature_download.py physical

Usage

In order to generate a data set, the main module must be executed. Assuming we are in the project folder, we can execute the main module using the following commands:

# Activate the virtual environment
conda activate icetrackdefs
# Launch the code
python src/SeaIceDeformation/main.py
# Deactivate the environment when you are done
conda deactivate

To use the analysis tools, we activate the Conda environment and run one of the two files in src/SatelliteCoverage/:

# Activate the virtual environment
conda activate icetrackdefs
# Launch the raw data anylsis tool
python src/SatelliteCoverage/coverage_frequency_map.py
# Deactivate the environment when you are done
conda deactivate

or

# Activate the virtual environment
conda activate icetrackdefs
# Launch the NetCDF tool
python src/SatelliteCoverage/netcdf_tools.py
# Deactivate the environment when you are done
conda deactivate

The user can configure the deformation calculations by modifying the definitions of the parameters in the configuration file src/SeaIceDeformation/namelist.ini, and the NetCDF analyses can be configured in src/SatelliteCoverage. In particular, the output_folder in the IO section should be modified to point to a filesystem location where one has write permissions.

Testing procedure

in ./data/ run test.sh

It will:

A PASS should be obtained for all the variables

Documentation

To generate PDF documentation for this project, start by accessing the docs folder (assuming we are already in the project folder):

cd docs

Finally, write the following command:

make SeaIceDeformation_doc.pdf

SeaIceDeformation_Methods.pdf will be stored in the current directory.

Input Data Location

The March and April 2020 Sentinel-1 and RCM ice tracker data stored in RCM_dats_2020_MarApr.tar.gz and S1_dats_2020_MarApr.tar.gz is located under /space/hall4/sitestore/eccc/crd/ccrp/mib001/jf_icetracker_data.