INSTALL.txt

# -----------------------------------------------------------------------------------------------------
# Requirements
# -----------------------------------------------------------------------------------------------------
# Basic installation
# Note that this install the requirements for the fourth day module, not the navier stokes code!
# For the navier stokes code, firedrake is required: https://firedrakeproject.org/
# optional: it is recommended to install fourth day into a virtual python environment
# optional: for ease of use we suggest using conda
conda create -name fd
conda activate fd

# install requirements
conda install --file requirements.txt

# Note that if using pip, please make sure the jupyter kernel is set correctly.
# Otherwise the steps should be similar

# -----------------------------------------------------------------------------------------------------
# Water current models
# For pre-simulated water current files please download from https://doi.org/10.7910/DVN/CNMW2S.
# Check example_dataverse_downloader on how to download these datasets using python and pyDataverse
# Note pyDataverse needs to be installed using pip install pyDataverse
# The location of these files needs to be config['water']['model']['directory'] = "../PATH/TO/FOLDER/"
# Otherwise one needs to run the navier-stokes code using firedrake.

# -----------------------------------------------------------------------------------------------------
# Optional
# -----------------------------------------------------------------------------------------------------
# The beta aspects require some additional packages