The basic structure is that the common functions are put under the /functions directory. Other project specific and on-the fly functions are put under their respective project directories, i.e. /turbulence, /windwave and /breaking.
Where functions are stored. Should
sys.path.append('/home/jiarong/research/postprocessing/functions/')so that functions can be found.
Files with capital letter contains classes, while files with lowercase letter can be called without an instance.
Where project specific jupyter notebooks are. Including ./windwave ./breaking and ./turbulence
Scripts that deal with video converting etc.
Documentation generated with sphinx. To be added.
./Matlab and ./Notebook Can be ignored.