SpeedyWeatherFTLE

Setting up the project for development

To set up the project for development for the first time, first clone this repository. Then, from the repository directory, open julia and run:

]instantiate
]activate .

instantiate creates a Manifest.toml file, which creates the environment that is needed for all future use of the package - you usually only need to instantiate once. activate . activates the environment in the present directory, that is, the current project.

Running the test suite located in ./test

Run the following code:

]test

TODOs:

• Publish this as a package so that it can be installed directly?
• Make some actual documentation
• Visualization functions:
  • Globe function (with slider?)
• currently only supports 1-layer simulations
• Suppress output when advecting
• Or would be nice to get output directly rather than write to then read from file. Cannot find how to do this in doc
• Modify functions to return ncdf filepath? output velocity fields if they are evolving?
• Can we compute the FTLE given a timeseries of u, v as opposed to solving the equations for them?
• Find a better method for inferring ntrunc from given spatial grid
• Write nice docstrings for everything
• General refactoring
• Add these as issues on github