Difference between revisions of "Retrieve file.m"
(Create documentation page from Spinach function header) |
(sync with Spinach main f053e432: file_path output description brought to head header) |
||
| (7 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:retrieve_file.m}} __NOTOC__ | {{DISPLAYTITLE:retrieve_file.m}} __NOTOC__ | ||
| − | Retrieves a file from an HTTPS link and stores it in a user- | + | Retrieves a file from an HTTPS link and stores it in a user-specified directory. |
==Syntax== | ==Syntax== | ||
| Line 6: | Line 6: | ||
file_path=retrieve_file(file_url,file_name,dest_dir) | file_path=retrieve_file(file_url,file_name,dest_dir) | ||
| − | == | + | ==Parameters== |
file_url - HTTPS URL pointing to the file to retrieve | file_url - HTTPS URL pointing to the file to retrieve | ||
| Line 14: | Line 14: | ||
==Outputs== | ==Outputs== | ||
| − | file_path - full path | + | file_path - full path of the downloaded file on disk |
==Examples== | ==Examples== | ||
| Line 23: | Line 23: | ||
==See also== | ==See also== | ||
| − | [[Main_Page]] | + | [[spinach2hiper.m]], [[awg_interface.m]], [[bootstrap.m]], [[gslice.m]], [[guess_csa_pro.m]], [[guess_j_nuc.m]], [[guess_j_pro.m]], [[py_run.m]], [[Import,_export,_and_visualisation]], [[Installation]], [[Matlab_configuration_advice]], [[Main_Page]], [[Kernel_utilities]] |
''Version 2.11, authors: [[Ilya Kuprov]]'' | ''Version 2.11, authors: [[Ilya Kuprov]]'' | ||
Latest revision as of 08:38, 30 August 2026
Retrieves a file from an HTTPS link and stores it in a user-specified directory.
Syntax
file_path=retrieve_file(file_url,file_name,dest_dir)
Parameters
file_url - HTTPS URL pointing to the file to retrieve
file_name - name of the file to be stored on disk
dest_dir - destination directory for the downloaded file
Outputs
file_path - full path of the downloaded file on disk
Examples
See examples in the Spinach distribution relevant to this function.
Notes
This page was generated from the function header in the Spinach repository.
See also
spinach2hiper.m, awg_interface.m, bootstrap.m, gslice.m, guess_csa_pro.m, guess_j_nuc.m, guess_j_pro.m, py_run.m, Import,_export,_and_visualisation, Installation, Matlab_configuration_advice, Main_Page, Kernel_utilities
Version 2.11, authors: Ilya Kuprov
