ktk.doc.download#

download(filename, **kwargs)[source]#

Download example data and return its local file name.

This function download example data from github. These data are the same that are used to generate the documentation website:

https://kineticstoolkit.uqam.ca

Parameters

filename (str) – A string that indicates which file to download.

Returns

The file name (with complete path) of the downloaded sample data.

Return type

str

Caution

These example data are volatile; they are supplied only for the user to reproduce the tutorials. Therefore, these data may change according to changes in the tutorials.

Note

The **kwargs arguments are for debugging and internal use only.