SWIIFT

Surface Wave Impact on sea Ice---Fracture Toolkit

A numerical model to study wave-induced fracture of sea ice floes.

• Installation
• Usage
• Development
• Acknowledgements

Installation

Make sure your Python version is at least 3.11. In a terminal, run

python -m venv .venv
source ./venv/bin/activate
python -m pip install --upgrade pip
python -m pip install git+ssh://git@github.com/sasip-climate/swiift.git#egg=swiift

to install the latest version of SWIIFT and its dependencies in a dedicated environment.

Alternatively, a specific version can be installed by specifying it in the git URL,

python -m pip install git+ssh://git@github.com/sasip-climate/swiift.git@$ver#egg=swiift

where $var is to be replaced by the desired version tag (for instance, v0.4.0).

Note

Depending on your system, you might have to replace the command python with python3, or even a specific minor version such as python3.11.

Usage

Setting up an experiment

Running an experiment

Helper classes

Development

Using Hatch

This project is managed with Hatch. Refer to its documentation for installation.

Once Hatch is installed, run

git clone git@github.com:sasip-climate/swiift.git
cd swiift
hatch test --all --parallel

to install SWIIFT along with its dependencies, and run the test suite in a dedicated environment.

Acknowledgements

This work is part of the SASIP project, funded by Schmidt Sciences.